GET /api/v2/organizations/{organization_id}/users

Returns a list of users for a specific organization.

Pagination

Cursor pagination (recommended)
Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

Admins, Agents and Light Agents

Servers

https://{subdomain}.{domain}.com

Path parameters

Name	Type	Required	Description
`organization_id`	Integer	Yes	The ID of an organization

Query parameters

Name	Type	Required	Description
`page`		No	Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: `?page=2` (integer page number) Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
`external_id`	String	No	List users by external id. External id has to be unique for each user under the same account.
`sort_order`	String	No	The sort order Valid values: `"desc"` `"asc"` Default value: "asc"
`per_page`	Integer	No	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
`role[]`	String	No	Filters the results by more than one role using the format `role[]={role}&role[]={role}`
`permission_set`	Integer	No	For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request
`role`	String	No	Filters the results by role. Possible values are "end-user", "agent", or "admin" Valid values: `"end-user"` `"agent"` `"admin"`
`sort_by`	String	No	The field to sort users by Valid values: `"id"` `"name"` `"created_at"` `"updated_at"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.