Autocomplete Organizations
GET {{baseUrl}}/api/v2/organizations/autocomplete?name=<string>&field_id=<string>&source=<string>
Returns an array of organizations whose name starts with the
value specified in the name parameter.
Pagination
- Offset pagination only
Allowed For
- Agents
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
name | string | (Required) A substring of an organization to search for | |
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
{"count":2,"next_page":null,"organizations":[{"created_at":"2018-11-14T00:14:52Z","details":"caterpillar =)","domain_names":["remain.com"],"external_id":null,"group_id":1835962,"id":35436,"name":"Important Customers","notes":"donkey","organization_fields":{"datepudding":"2018-11-04T00:00:00+00:00","org_field_1":"happy happy","org_field_2":"teapot_kettle"},"shared_comments":false,"shared_tickets":false,"tags":["smiley","teapot_kettle"],"updated_at":"2018-11-14T00:54:22Z","url":"https://example.zendesk.com/api/v2/organizations/4112492.json"},{"created_at":"2017-08-14T20:13:52Z","details":"test","domain_names":["test.com"],"external_id":null,"group_id":null,"id":20057623,"name":"Imperial College","notes":"","organization_fields":{"datepudding":"2018-11-02T00:00:00+00:00","org_field_1":"malarky","org_field_2":"teapot_kettle"},"shared_comments":false,"shared_tickets":false,"tags":["teapot_kettle"],"updated_at":"2019-05-16T01:27:46Z","url":"https://example.zendesk.com.com/api/v2/organizations/1873.json"}],"previous_page":null}