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

KeyDatatypeRequiredDescription
namestring(Required) The name to search for the user.
field_idstringThe id of a lookup relationship field. The type of field is determined
by the source param
sourcestringIf 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

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;users&quot;:[{&quot;id&quot;:35436,&quot;name&quot;:&quot;Robert Jones&quot;,&quot;notes&quot;:&quot;sigil issue&quot;},{&quot;id&quot;:9873843,&quot;name&quot;:&quot;Terry Gilliam&quot;}]}