younifyd
Menu

Autocomplete Users Post

Autocomplete Users by Request Body

POST/api/v2/users/autocomplete

Use it in a workflow

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

Request

Query parameters

includestring

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

filterstring

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

per_pageinteger

Number of results to return.

Request body

Enter the body as JSON in the step's Body field.

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).

field_idinteger (int64)

Field ID for lookup relationship autocomplete

filteroneOf

Filter to apply (assignable, requester, or dynamic_values)

namestring

The name to search for the user

phonestring

The phone number to search for the user

sourcestring

Source for lookup relationship autocomplete

json
{
  "brand_id": null,
  "field_id": 0,
  "filter": null,
  "name": "gil",
  "phone": "string",
  "source": "string"
}

Response

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

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

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

Autocomplete Users Post — Zendesk — Documentation