Data / Fetch users

Task in alpha phase

This Data Factory task is in phase. You can contact the Product-Live team at contact@product-live.com if you want more details and get an early access.

This task allows to fetch all users on your account.

Task name:

Examples

Fetch all users

{
    "name": "data-fetch-users",
    "taskReferenceName": "fetch_users",
    "description": "Fetch users",
    "type": "SUB_WORKFLOW",
    "optional": false,
    "inputParameters": {
        "apiKey": "${workflow.variable.api_key}"
    }
}

Definition

Property	Type	Required	Description
			The name (or type) of the task
			The unique name of the task in your job. It is used to reference this task in the workflow.
			The functional description of this task in your job.
			The type of the task. It must be SUB_WORKFLOW.
			true: the job continues if there is an error on this task. false: the job fails.
			Input parameters of the task. See below

Inputs Parameters

Property	Type	Required	Description
			The Product-Live API key
			ALL: Fetch all users.
			The maximum number of elements to be returned by the task. If not set, the task returns the maximum number of elements available. If the limit property is less than the maximum number of elements that can be returned, the task returns the number of elements specified by the limit property.

Outputs

Property	Type	Description
		The total number of users
		The list of users, for more information regarding the user object, please refer to the API documentation

Limits and additional notes

• The maximum number of elements returned by this task is limited to 1000. If more elements are to be returned, the task ends with an error. The limit property is used to specify the maximum number of elements to be returned by the task, even if other elements are available. If the limit property is not set, the task returns the maximum number of elements available. If the limit property is less than the maximum number of elements that can be returned, the task returns the number of elements specified by the limit property and ends with a success.