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
- Agents
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
source |
String | No |
If a |
name |
String | No |
The name to search for the user. You must specify either |
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: Valid values:
|
field_id |
String | No |
The id of a lookup relationship field. The type of field is determined
by the |
per_page |
Integer | No |
Number of results to return. |
phone |
String | No |
The phone number to search for the user. You must specify either |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.