POST /api/v2/users/autocomplete

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

This endpoint accepts the same parameters as the GET method but they are specified in the request body instead of the query string.

Allowed For

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
source String No

Source for lookup relationship autocomplete

name String Yes

The name to search for the user

field_id Integer No

Field ID for lookup relationship autocomplete

filter No

Filter to apply (assignable, requester, or dynamic_values)

phone String No

The phone number to search for the user

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.