GET /api/v2/users/show_many

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

Allowed For:

Servers

Query parameters

Name Type Required Description
external_ids String No

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

brand_id Integer No

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. Omitting brand_id always uses account scope (0), regardless of account or Agent Workspace defaults.

Accepted values when used with external_ids:

  • 0 — restrict the lookup to account-scoped (brand-less) users only.
  • A numeric brand id — if the brand has user separation enabled, return only users belonging to that brand; account-scoped agents and admins are excluded. If the brand does not have user separation enabled, the request resolves to account scope (0), including account-scoped agents and end users.
  • "all" — invalid for show_many lookups.

When ids is provided instead of external_ids, numeric brand scopes are accepted but filtering is not applied because user IDs are globally unique. brand_id=all is rejected consistently with the other many-user endpoints.

include String No

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

ids String No

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

include_deleted Boolean No

If true, returns inactive or deleted users.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.