Organizations

List Organizations

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

  • Agents, with certain restrictions

If the agent has a custom agent role that restricts their access to only users in their own organization, a 403 Forbidden error is returned. See Creating custom agent roles in Zendesk help.

get/api/v2/organizations

Query parameters

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

Response

Success response

countinteger
next_pagestring nullable
previous_pagestring nullable

Example response

{
  "organizations": [
    {
      "created_at": "2009-07-20T22:55:29Z",
      "details": "This is a kind of organization",
      "domain_names": [
        "example.com",
        "test.com"
      ],
      "external_id": "ABC123",
      "group_id": null,
      "id": 35436,
      "name": "One Organization",
      "notes": "",
      "organization_fields": {
        "org_decimal": 5.2,
        "org_dropdown": "option_1"
      },
      "shared_comments": true,
      "shared_tickets": true,
      "tags": [
        "enterprise",
        "other_tag"
      ],
      "updated_at": "2011-05-05T10:38:52Z",
      "url": "https://company.zendesk.com/api/v2/organizations/35436.json"
    }
  ]
}

Changes