Search Organizations by External ID
GET {{baseUrl}}/api/v2/organizations/search?external_id=<integer>
If you set the external_id value of an organization to associate it to an external record, you can use the external id to search for the organization.
Allowed For:
- Admins
- Agents assigned to a custom role with permissions to add or modify organizations (Enterprise only)
See Creating custom agent roles in the Support Help Center.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
external_id | string | (Required) The external id of an organization |
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":"ABC198","group_id":1835962,"id":4112492,"name":"Groablet Enterprises","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":"TTV273","group_id":null,"id":1873,"name":"Willy Wonkas Chocolate Factory","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}