Organizations
Returns organizations, including group assignments, domain names, and tag details.
Table-Specific Information
Select
The provider uses the Zendesk API to process WHERE clause conditions built with the following columns and operators:- Id supports the =, IN operators.
- Name supports the = operator.
- Details supports the = operator.
- Notes supports the = operator.
- Tags supports the = operator.
- UserId supports the = operator.
- CreatedAt supports the >, <, >=, <= operators.
- UpdatedAt supports the >=, <=, >, < operators.
For example, the following queries are processed server-side while other filters are processed client-side within the provider.
SELECT * FROM Organizations WHERE Id = '123'
SELECT * FROM Organizations WHERE Id IN ('123', '456')
SELECT * FROM Organizations WHERE UserId = '123'
Insert
The Name column is required to insert. This operation is allowed for logged-in users with the "admin" role only.
Note: You must provide a unique name for each organization. Normally, the system does not allow records to be created with identical names; however, a race condition can occur if you make two or more identical POSTs very close to each other, causing the records to have identical organization names.
INSERT INTO Organizations (Name) VALUES ('My Organization')
To create many organizations, see "Batch Processing" for an example.
Update
You must specify the Id of the organization to update it. All fields that are not readonly are optional. This operation is allowed for logged-in users with the "admin" role only.
UPDATE Organizations SET Notes = 'Something interesting' WHERE Id = '123'
To make the same change to multiple organizations, use the following SQL statement:
UPDATE Organizations SET Notes = 'Something interesting' WHERE Id IN ('123', '456')
To make different changes to many organizations, see "Batch Processing" for an example.
Delete
You must specify the Id of the organization to delete it. This operation is allowed for logged-in users with the "admin" role only.
DELETE FROM Organizations WHERE Id = '123'
You can delete multiple organizations simultaneously by providing their Ids:
DELETE FROM Organizations WHERE Id IN ('123', '456')
You can also delete many organizations simultaneously by using "Batch Processing".
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
The unique Id automatically assigned when the organization is created. | |
| Name | String | False |
A unique name for the organization. | |
| GroupId | Long | False |
Groups.Id |
New tickets from users in this organization are automatically put in this group. |
| ExternalId | String | False |
A unique external id to associate organizations to an external record. | |
| CreatedAt | Datetime | True |
The date and time when the organization was created. | |
| UpdatedAt | Datetime | True |
The date and time when the organization was last updated. | |
| DomainNames | String | False |
An array of domain names associated with this organization. | |
| Details | String | False |
Any details about the organization, such as the address. | |
| Notes | String | False |
Any notes you have about the organization. | |
| SharedTickets | Boolean | False |
Indicates whether end users in this organization are able to see each other's tickets. | |
| SharedComments | Boolean | False |
Indicates whether end users in this organization are able to see comments on each other's tickets. | |
| Tags | String | False |
The tags of the organization. | |
| Url | String | True |
The URL for this resource. | |
| UserId | Long | False |
The Id of the user used to query organizations. |