Search Organizations

GET/api/v2/organizations/search

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the Search Organizations action (under Organizations).
Fill in the fields below, then reference the result from later steps as {{searchOrganizations.response.data}}.

Request

Query parameters

external_idinteger

The external id of an organization

namestring

The name of an organization

Response

Returns 200 with an object. Read it in later steps with {{searchOrganizations.response.data.<field>}}.

countinteger

next_pagestring

organizationsarray<object>

created_atstring

The time the organization was created

detailsstring

Any details obout the organization, such as the address

domain_namesarray<string>

An array of domain names associated with this organization

external_idstring

A unique external id to associate organizations to an external record. The id is case-insensitive. For example, "company1" and "Company1" are considered the same

group_idinteger (int64)

New tickets from users in this organization are automatically put in this group

idinteger (int64)

Automatically assigned when the organization is created

namestringrequired

A unique name for the organization

notesstring

Any notes you have about the organization

organization_fieldsobject

Custom fields for this organization. See [Custom organization fields](/api-reference/ticketing/organizations/organizations/#custom-organization-fields)

shared_commentsboolean

End users in this organization are able to comment on each other's tickets

shared_ticketsboolean

End users in this organization are able to see each other's tickets

tagsarray<string>

The tags of the organization

updated_atstring

The time of the last update of the organization

urlstring

The API url of this organization

previous_pagestring

json

{
  "count": 0,
  "next_page": "string",
  "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"
    }
  ],
  "previous_page": "string"
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?