younifyd
Menu

Autocomplete Users

Autocomplete Users

GET/api/v2/users/autocomplete

Use it in a workflow

  1. Add a step and choose the Zendesk connector.
  2. Pick the Autocomplete Users action (under Users).
  3. Fill in the fields below, then reference the result from later steps as {{autocompleteUsers.response.data}}.

Request

Query parameters

namestring

The name to search for the user. You must specify either `name` or `phone`.

phonestring

The phone number to search for the user. You must specify either `name` or `phone`.

filterstring

Filter to apply to autocomplete results. Accepted values: `assignable`, `requester`.

One ofassignablerequester

field_idstring

The id of a lookup relationship field. The type of field is determined by the `source` param

sourcestring

If a `field_id` is provided, this specifies the type of the field. For example, if the field is on a "zen:user", it references a field on a user

includestring

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

per_pageinteger

Number of results to return.

brand_idoneOf

When brand separation is enabled, scopes the autocomplete results to users belonging to the specified brand. Only applicable when the account has brand separation enabled. Accepted values: * "all" — search all users across all brands (no brand filtering applied). * 0 — restrict the autocomplete results to account-scoped (brand-less) users only. * A numeric brand id — if the brand has user separation enabled, autocomplete returns only end users belonging to that brand. Agents and admins are not included in the results when filtering by a specific brand. If the brand does not have user separation enabled, the request falls back to account scope (0).

Response

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

usersarray<oneOf>
json
{
  "users": [
    null
  ]
}

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