GET /api/v2/users

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.

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

When true, includes has_more indicator in the cursor pagination response meta.

Only valid with cursor pagination (page[size], page[after], page[before]).

Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading.

Number of records to return per page.

Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.

Field to sort results by. Prefix with - for descending order.

When used with cursor pagination, this determines the cursor ordering.

Example: ?sort=name or ?sort=-created_at

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

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

When true, includes cursor values for each item in the cursor pagination response.

Only valid with cursor pagination (page[size], page[after], page[before]).

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

Valid values:

• "end-user"
• "agent"
• "admin"