BObotbrains-io
Users

Autocomplete Users

Changed on

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
get/api/v2/users/autocomplete

Request

Query parameters

namestring required

The name to search for the user.

field_idstring

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

sourcestring

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

Response

Success response

Changes

  • 9eac011b0efdRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • info

      removed from the / response property anyOf list for the response status