Skip to main content
List and query users.

​
Basic Parameters

ParameterDescription
Per PageNumber of results per page, valid range is 1-100.
QueryFull text query string, search in firstname, lastname and email.

​
Advanced Parameters

ParameterDescription
ActiveIf true, returns only the users who have logged in on the platform at least once.
EmailSearch by email (exact).
External IDSearch by external ID (exact).
FirstnameSearch by firstname (exact).
LastnameSearch by lastname (exact).
Organization IDReturns the users who have a profile linked to this organization.
Role IDReturns all the users who have this role.

​
Example Output

[
	{
		"external_id": "string",
		"firstname": "string",
		"lastname": "string",
		"middlename": "string",
		"email": "string",
		"language": "string",
		"timezone": "string",
		"mobile_phone_number": "string",
		"profiles": [
			{
				"role_id": "string",
				"employees_perimeter": {
					"operator": "=",
					"organization_id": "string",
					"organization_group_id": "string",
					"custom_field_filters": [
						{
							"custom_field_id": "string",
							"operator": "=",
							"value": "string"
						}
					]
				},
				"id": "string"
			}
		],
		"id": "string",
		"created_at": "2023-11-13T19:38:53.991Z",
		"updated_at": "2023-11-13T19:38:53.991Z"
	}
]

​
Workflow Library Example

List Users with Ukg Hr and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop