GET /api/v2/users/autocomplete

Returns an array of users whose name starts with the value specified in the name parameter. It only returns users with no foreign identities.

Allowed For

Servers

Query parameters

Name Type Required Description
source String No

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

name String No

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

include String No

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

filter String No

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

Valid values:

  • "assignable"
  • "requester"
field_id String No

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

per_page Integer No

Number of results to return.

phone String No

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

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.