Autocomplete Users
GET {{baseUrl}}/api/v2/users/autocomplete?name=<string>&field_id=<string>&source=<string>
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
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
name | string | (Required) The name to search for the user. | |
field_id | string | The id of a lookup relationship field. The type of field is determined | |
by the source param | |||
source | string | 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 | |||
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"users":[{"id":35436,"name":"Robert Jones","notes":"sigil issue"},{"id":9873843,"name":"Terry Gilliam"}]}