Explore the Zendesk API data model

See how the various Zendesk endpoints relate to each other, using our handy Entity Relationship Diagram

Try our interactive ERD Or, browse below

Pulling data from the Zendesk API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Zendesk API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Automation

Documentation: https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
CreatedAt datetime - -
UpdatedAt datetime - -
Title string - -
Active boolean - -
Default boolean - -
Position int - -

Brand

Documentation: https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Subdomain string - -
HasHelpCenter boolean - -
HelpCenterState string - -
Active boolean - -
Default boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

CustomStatus

Documentation: https://developer.zendesk.com/api-reference/ticketing/tickets/custom_ticket_statuses/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Description string - -
Active boolean - -
StatusCategory string - -
AgentLabel string - -
Default boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

Group

Documentation: https://developer.zendesk.com/api-reference/ticketing/groups/groups/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
IsPublic boolean - -
Default boolean - -
Deleted boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

GroupMembership

Documentation: https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/

Column Type Relates to Notes
RemoteID string - -
GroupRemoteID string Group → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
GroupID long Group → ID -
UserID long User → ID -
Default boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

Organisation

Documentation: https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
SharedTickets boolean - -
SharedComments boolean - -
ExternalID string - -
Details string - -
Notes string - -
GroupID long Group → ID -
CreatedAt datetime - -
UpdatedAt datetime - -

OrganisationMembership

Documentation: https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/

Column Type Relates to Notes
RemoteID string - -
OrganisationRemoteID string Organisation → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
OrganizationID long Organisation → ID -
UserID long User → ID -
Default boolean - -
ViewTickets boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

SatisfactionRating

Documentation: https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
AssigneeID long User → ID -
GroupID long Group → ID -
RequesterID long User → ID -
TicketID long Ticket → ID -
ReasonID long SatisfactionReason → ID -
Comment string - -
Score string - -
CreatedAt datetime - -
UpdatedAt datetime - -

SatisfactionReason

Documentation: https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_reasons/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
ReasonCode int - -
Value string - -
Active boolean - -
DeletedAt datetime - -
CreatedAt datetime - -
UpdatedAt datetime - -

Ticket

Documentation: https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Description string - -
DeletedAt datetime -
  • 7 Apr 2024 This is set manually, not by the endpoint itself
Type string - -
Subject string - -
Priority string - -
Status string - -
Recipient string - -
RequesterID long User → ID -
SubmitterID long User → ID -
AssigneeID long User → ID -
OrganizationID long Organisation → ID -
GroupID long Group → ID -
ForumTopicID long - -
ProblemID long -
  • 26 Mar 2024 Foreign Key - Refers to 'Ticket Problems' (not implemented)
HasIncidents boolean - -
IsPublic boolean - -
DueAt datetime - -
SatisfactionRatingID long SatisfactionRating → ID -
CustomStatusID long CustomStatus → ID -
BrandID long Brand → ID -
AllowChannelback boolean - -
AllowAttachments boolean - -
FromMessagingChannel boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

TicketAudit

Documentation: https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_audits/

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
TicketID long Ticket → ID -
CreatedAt datetime - -
AuthorID long User → ID -

TicketComment

Documentation: https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
TicketID long Ticket → ID -
CreatedAt datetime - -
Type string - -
AuthorID long User → ID -
Body string - -
Public boolean - -
AuditID long TicketAudit → ID -

TicketField

Documentation: https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Description string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Type string - -
Title string - -
Position int - -
Active boolean - -
Required boolean - -

TicketForm

Documentation: https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Position int - -
Active boolean - -
Default boolean - -

Trigger

Documentation: https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Description string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Title string - -
Active boolean - -
Default boolean - -
Position int - -
CategoryID long TriggerCategory → ID -

TriggerCategory

Documentation: https://developer.zendesk.com/api-reference/ticketing/business-rules/trigger_categories/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Position int - -

User

Documentation: https://developer.zendesk.com/api-reference/ticketing/users/users/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Email string - -
Phone string - -
PhotoID long - -
OrganizationID long Organisation → ID -
Role string - -
Verified boolean - -
ExternalID string - -
Alias string - -
Active boolean - -
Shared boolean - -
SharedAgent boolean - -
LastLoginAt datetime - -
Signature string - -
Details string - -
Notes string - -
CustomRoleID long -
  • 26 Mar 2024 Foreign Key - Refers to 'Custom Agent Roles' (not implemented)
Moderator boolean - -
TicketRestriction string - -
OnlyPrivateComments boolean - -
RestrictedAgent boolean - -
Suspended boolean - -
DefaultGroupID long Group → ID -

UserIdentity

Documentation: https://developer.zendesk.com/api-reference/ticketing/users/user_identities/

Column Type Relates to Notes
RemoteID string - -
UserRemoteID string User → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
UserID long User → ID -
Type string - -
Value string - -
Verified boolean - -
Primary boolean - -
UndeliverableCount int - -
DeliverableState string - -
CreatedAt datetime - -
UpdatedAt datetime - -

View

Documentation: https://developer.zendesk.com/api-reference/ticketing/business-rules/views/

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Description string - -
CreatedAt datetime - -
UpdatedAt datetime - -
Title string - -
Active boolean - -
Default boolean - -
Position int - -

AutomationCondition

Column Type Relates to Notes
RemoteID string - -
AutomationRemoteID string Automation → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AutomationID long Automation → ID -
LineNumber int - -
Type string - -
Field string - -
Operator string - -
Value string - -

AutomationAction

Column Type Relates to Notes
RemoteID string - -
AutomationRemoteID string Automation → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
AutomationID long Automation → ID -
LineNumber int - -
Field string - -

OrganisationDomain

Column Type Relates to Notes
RemoteID string - -
OrganisationRemoteID string Organisation → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
OrganisationID long Organisation → ID -
LineNumber int - -
Value string - -

OrganisationTag

Column Type Relates to Notes
RemoteID string - -
OrganisationRemoteID string Organisation → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ParentID long Organisation → ID -
LineNumber int - -
Value string - -

TicketFollowUp

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ParentTicketID long Ticket → ID -
FollowUpTicketID long Ticket → ID -

TicketTag

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ParentID long Ticket → ID -
LineNumber int - -
Value string - -

TicketFollower

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TicketID long Ticket → ID -
UserID long User → ID -

TicketCollaborator

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TicketID long Ticket → ID -
UserID long User → ID -

TicketEmailCC

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TicketID long Ticket → ID -
UserID long User → ID -

TicketCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
TicketRemoteID string Ticket → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long TicketField → ID -
TicketID long Ticket → ID -

TicketAuditCommentEvent

Column Type Relates to Notes
RemoteID string - -
TicketAuditRemoteID string TicketAudit → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
TicketAuditID long TicketAudit → ID -
CommentID long TicketComment → ID -
Type string - -

TicketAuditCreateEvent

Column Type Relates to Notes
RemoteID string - -
TicketAuditRemoteID string TicketAudit → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
TicketAuditID long TicketAudit → ID -
Type string - -
FieldName string - -
AssigneeID long User → ID -
GroupID long Group → ID -
RequesterID long User → ID -
TicketFormID long TicketForm → ID -
OrganisationID long Organisation → ID -

TicketAuditNotificationEvent

Column Type Relates to Notes
RemoteID string - -
TicketAuditRemoteID string TicketAudit → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
TicketAuditID long TicketAudit → ID -
Subject string - -
Body string - -
Type string - -

TicketAuditChangeEvent

Column Type Relates to Notes
RemoteID string - -
TicketAuditRemoteID string TicketAudit → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
TicketAuditID long TicketAudit → ID -
FieldName string - -
AssigneeID long User → ID -
GroupID long Group → ID -
RequesterID long User → ID -
TicketFormID long TicketForm → ID -
OrganisationID long Organisation → ID -
Type string - -

TicketCommentAttachment

Column Type Relates to Notes
RemoteID string - -
TicketCommentRemoteID string TicketComment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
TicketCommentID long TicketComment → ID -
CreatedAt datetime - -
FileName string - -
ContentType string - -
Size decimal - -
Deleted boolean - -

TicketFormField

Column Type Relates to Notes
RemoteID string - -
TicketFormRemoteID string TicketForm → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TicketFormID long TicketForm → ID -
TicketFieldID long TicketField → ID -

TriggerCondition

Column Type Relates to Notes
RemoteID string - -
TriggerRemoteID string Trigger → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TriggerID long Trigger → ID -
LineNumber int - -
Type string - -
Field string - -
Operator string - -
Value string - -

TriggerAction

Column Type Relates to Notes
RemoteID string - -
TriggerRemoteID string Trigger → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TriggerID long Trigger → ID -
LineNumber int - -
Field string - -

UserTag

Column Type Relates to Notes
RemoteID string - -
UserRemoteID string User → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ParentID long User → ID -
LineNumber int - -
Value string - -

ViewField

Column Type Relates to Notes
RemoteID string - -
ViewRemoteID string View → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
ViewID long View → ID -
Title string - -
Filterable boolean - -
Sortable boolean - -

ViewCustomField

Column Type Relates to Notes
RemoteID string - -
ViewRemoteID string View → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long TicketField → ID -
ViewID long View → ID -
Title string - -
Type string - -
Filterable boolean - -
Sortable boolean - -

ViewConditionAll

Column Type Relates to Notes
RemoteID string - -
ViewRemoteID string View → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ViewID long View → ID -
LineNumber int - -
Field string - -
Operator string - -
Value string - -

ViewConditionAny

Column Type Relates to Notes
RemoteID string - -
ViewRemoteID string View → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ViewID long View → ID -
LineNumber int - -
Field string - -
Operator string - -
Value string - -

AutomationActionValue

Column Type Relates to Notes
RemoteID string - -
AutomationActionRemoteID string AutomationAction → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Key string - -
Value string - -

TicketCustomFieldValueOption

Column Type Relates to Notes
RemoteID string - -
TicketCustomFieldValueRemoteID string TicketCustomFieldValue → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Value string - -

TicketAuditCreateEventValue

Column Type Relates to Notes
RemoteID string - -
TicketAuditCreateEventRemoteID string TicketAuditCreateEvent → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Key string - -
Value string - -

TicketAuditNotificationEventRecipient

Column Type Relates to Notes
RemoteID string - -
TicketAuditNotificationEventRemoteID string TicketAuditNotificationEvent → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
EventID long TicketAuditNotificationEvent → ID -
RecipientID long User → ID -

TicketAuditChangeEventValue

Column Type Relates to Notes
RemoteID string - -
TicketAuditChangeEventRemoteID string TicketAuditChangeEvent → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Key string - -
Value string - -

TicketAuditChangeEventPreviousValue

Column Type Relates to Notes
RemoteID string - -
TicketAuditChangeEventRemoteID string TicketAuditChangeEvent → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Key string - -
Value string - -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.

Connect your own Zendesk data Querying Zendesk using regular SQL