List Organization Users

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

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the List Organization Users action (under Users).
Fill in the fields below, then reference the result from later steps as {{listOrganizationUsers.response.data}}.

Request

Path parameters

organization_idinteger (int64)required

The ID of an organization

Query parameters

rolestring

Filters the results by role. Possible values are "end-user", "agent", "admin", or a custom role name

role[]array<string>

Filters the results by more than one role using the format `role[]={role}&role[]={role}`

permission_setinteger (int64)

For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request

external_idstring

List users by external id. External id has to be unique for each user under the same account.

sort_bystring

The field to sort users by

One ofidnamecreated_atupdated_at

sort_orderstring

The sort order

One ofascdescDefault "asc"

pageoneOf

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.

per_pageinteger

Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.

Response

Returns 200 with an object. Read it in later steps with {{listOrganizationUsers.response.data.<field>}}.

usersarray<oneOf>

json

{
  "users": [
    null
  ]
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?