Show Many Users

GET/api/v2/users/show_many

Use it in a workflow

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

Request

Query parameters

idsstring

Accepts a comma-separated list of up to 100 user ids.

external_idsstring

Accepts a comma-separated list of up to 100 external ids.

include_deletedboolean

If true, returns inactive or deleted users.

brand_idoneOf

When brand separation is enabled and `external_ids` is provided, scopes the lookup to users belonging to the specified brand. Only applicable when the account has brand separation enabled. Accepted values: * "all" — return all matching users across all brands (no brand filtering applied). * 0 — restrict the lookup to account-scoped (brand-less) users only. * A numeric brand id — if the brand has user separation enabled, return end users belonging to that brand plus all agents and admins (who are account-level and always included). If the brand does not have user separation enabled, the request falls back to account scope (0). When `ids` is provided instead of `external_ids`, brand filtering is not applied (user IDs are globally unique).

includestring

Sideloads to include in the response. Accepts a comma-separated list of values. See [Sideloading](/api-reference/ticketing/users/users/#sideloading).

Response

Returns 200 with an object. Read it in later steps with {{showManyUsers.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?