Articles in this section

Available Zendesk APIs

When you configure an export, import, other type of flow step using the prebuilt Zendesk connector, you can select any of the API operations attached below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Zendesk API documentation. You can also create a composite endpoint for this application in HTTP mode.

Zendesk Support APIs

Resource API endpoint Export Import
Account settings Show settings X
Update account settings X
Activity stream Count activities X
App installation locations List location installations X
Reorder app installations for location X
App locations List locations X
Show location X
Approval requests Show approval request X
Update approval request status X
Get approvals by approval workflow ID X
Apps Get information about app X
Show app installation X
Get job status X
Get requirements install status X
List requirements X
List owned apps X
List all apps X
List all installations X
Create app X
Send notification to app X
Install app X
Update app installation X
Remove app installation X
Update app X
Delete app X
Assignee field assignable agents List assignable groups and agents based on query matched against name X
List assignable groups on the assignee field X
List assignable agents from a group on the assignee field X
Attachments Show attachment X
Update attachment for malware X
Redact comment attachment X
Upload files X
Delete upload X
Audit logs Listing audit logs X
Getting audit logs X
Export audit logs X
Automations List automations X
Show automation X
Search automations X
List active automations X
Create X
Update X
Update many automations X
Delete X
Bulk delete automations X
Basics Open ticket in agent's browser X
Open a user's profile in an agent's browser X
Create ticket or voicemail ticket X
Bookmarks List bookmarks X
Create bookmark X
Delete bookmark X
Brand agents List brand agent memberships X
Show brand agent membership X
Brands List brands X
Show a brand X
Create X
Update X
Delete X
Check host mapping validity for an existing brand X
Check host mapping validity X
Channel framework Push content to support X
Validate token X
Report channel back error to zendesk X
Clients Create client X
Update client X
Delete X
Conversation log List conversation log for ticket X
Custom agent roles List custom roles X
Show custom role X
Create custom role X
Update custom role X
Delete custom role X
Custom object fields List custom object fields X
Create custom object field X
Show custom object field X
Update custom object field X
Delete custom object field X
Reorder custom fields of an object X
Custom object fields limit X
Custom object permissions List access rules X
Create access rule X
Show access rule X
Update access rule X
Delete access rule X
List access rule definitions X
List permission policies X
Show permission policy X
Update permission policy X
Custom object record attachments List custom object record attachments X
Create custom object record attachment X
Update custom object record attachment for malware X
Delete custom object record attachment X
Download custom object record attachment X
Custom object records Custom object record bulk jobs X
List custom object records X
Create custom object record X
Set custom object record by external ID or name X
Delete custom object record by external ID or name X
Show custom object record X
Update custom object record X
Delete custom object record X
Autocomplete custom object record search X
Count custom object records X
Search custom object records X
Filtered search of custom object records X
Custom object records limit X
Custom objects List custom objects X
Create custom object X
Show custom object X
Update custom object X
Delete custom object X
Custom objects limit X
Custom ticket statuses Bulk update default custom ticket status X
List custom ticket statuses X
Create custom ticket status X
Show custom ticket status X
Update custom ticket status X
Deletion schedules List deletion schedules X
Create deletion schedule X
Get deletion schedule X
Update deletion schedule X
Delete deletion schedule X
Dynamic content List items X
Show many items X
Show item X
List variants X
Show variant X
Create item X
Create variant X
Update item X
Update variants X
Delete item X
Delete variant X
Dynamic content item variants Create many variants X
Update many variants X
Email notifications List email notifications X
Show email notification X
Show many email notifications X
End users Show end user X
Update end user X
Essentials card Show essentials card X
Update essentials card X
Delete essentials card X
List of essentials cards X
Global clients List global oauth clients X
Show global oauth client X
Show token summary for global oauth clients X
Group memberships List memberships X
List assignable memberships X
List assignable memberships based on ID X
List memberships based on user ID X
List groups based on group ID X
Show group memberships based on ID X
Create X
Create membership based on ID X
Update X
Delete membership X
Delete membership based on ID X
Bulk create memberships X
Bulk delete memberships X
Group SLA policies List group SLA policies X
Create group SLA policy X
Show group SLA policy X
Update group SLA policy X
Delete group SLA policy X
Retrieve supported filter definition items X
Reorder group SLA policies X
Groups List groups X
Show assignable groups X
List groups based on ID X
Show group based on ID X
Create groups X
Update groups X
Delete X
Count groups X
Incremental export Incremental custom object record export, cursor based X
Incremental ticket export, cursor based X
Incremental user export, cursor based X
Incremental exports Incremental ticket export X
Incremental ticket event exports X
Incremental organization exports X
Incremental user exports X
Incremental sample export X
Incremental ticket metric event export X
Incremental skill-based routing Incremental attributes export X
Incremental attribute values export X
Incremental instance values export X
Job statuses List job statuses X
Show job status X
Show many job statuses X
Lead unqualified reasons Retrieve all lead unqualified reasons X
Locales List locales X
List available public locales X
List locales for agent X
Show locale X
Show current locale X
Detect best language for user X
Lookup relationships Get sources by target X
Filter definitions X
Macros List macros X
List supported actions for macros X
List macro categories X
List macro action definitions X
Show macro X
Show macro replica X
Show changes to ticket X
List macro attachments X
Show macro attachment X
Show ticket after changes X
Search macros X
List active macros X
Create X
Update X
Update many macros X
Delete X
Bulk delete macros X
Create macro attachment X
Create unassociated macro attachment X
Bulk delete macros X
Oauth clients List clients X
Show client X
Create client X
Update client X
Delete client X
Generate secret X
Oauth tokens Create token X
Revoke token X
List tokens X
Show token X
Object triggers List object triggers X
Create object trigger X
Show object trigger X
Update object trigger X
Delete object trigger X
List active object triggers X
List object trigger action and condition definitions X
Delete many object triggers X
Search object triggers X
Update many object triggers X
Omnichannel routing queues List queues X
Create queue X
Show queue X
Update queue X
Delete queue X
List queue definitions X
Reorder queues X
Organization fields List organization fields X
Show organization field X
Create X
Update X
Delete X
Reorder organization field X
Organization memberships List memberships X
List memberships based on user ID X
Show membership X
Show membership based on user ID and membership ID X
List memberships based on organization ID X
Create membership X
Create membership based on ID X
Set membership as default X
Create many memberships X
Delete membership X
Delete membership based on ID X
Bulk delete memberships X
Unassign organization X
Set organization as default X
Organization subscriptions List organization subscriptions X
List organization subscriptions based on organization ID X
Show organization subscription X
Create organization subscription X
Delete X
Show organization subscription X
Organizations List organizations X
List organizations using userid parameter X
Autocomplete organizations X
Show organization related information X
Show organization X
Show many organizations X
Search organizations X
Create X
Update X
Delete X
Show organization merge X
Merge organization with another organization X
List organization merges X
Count organizations X
Create many organizations X
Create or update organization X
Bulk delete organizations X
Search organizations X
Update many organizations X
Products Retrieve all products X
Retrieve a single product X
Create a product X
Update a product X
Delete a product X
Push notification devices Bulk unregister push notification devices X
Remote authentications List remote authentications X
Requests List requests X
Get requests in open status X
Get requests in solved status X
Get requests in ccd status X
Search requests X
Show request X
Listing comments X
Getting comments X
Create X
Update X
Reseller Create trial account X
Verify subdomain availability X
Resource collections List resource collections X
Retrieve a resource collection X
Create a resource collection X
Update a resource collection X
Delete a resource collection X
Satisfaction ratings List satisfaction ratings X
Show satisfaction rating X
Create X
Count satisfaction ratings X
Satisfaction reasons List reasons for satisfaction rating X
Show reason for satisfaction rating X
Schedules List all schedules X
Show a schedule X
List holidays for a schedule X
Show a holiday X
Create a schedule X
Create holiday X
Update schedule X
Update holidays X
Delete schedule X
Delete holiday X
Search Show results count X
Export search results X
Security settings Show security settings X
Sessions List sessions X
Show the currently authenticated session X
Renew the current session X
Show session X
Delete X
Bulk delete sessions X
Delete the authenticated session X
Sharing agreements List sharing agreements X
Show a sharing agreement X
Create X
Update X
Delete X
Side conversations List side conversations X
Show side conversation X
Skill based routing Bulk set agent attribute values job X
Set agent attribute values X
List attribute values for many agents X
Update attribute X
Set ticket attribute values X
List account attributes X
List tickets fulfilled by a user X
Show many items X
Show attribute X
List ticket attribute values X
List agent attribute values X
Show attribute value X
List routing attribute definitions X
List attribute values for an attribute X
Create attribute X
Update attribute X
Delete attribute X
Create attribute value X
Update attribute value X
Delete attribute value X
SLA policies List SLA policies X
Get SLA policy X
Retrieve supported filter definition items X
SLA policy Create X
Update X
Reorder SLA policies X
Delete X
Support addresses List support addresses X
Show support address X
Create X
Update X
Delete X
Verify support address forwarding X
Suspended ticket Recover suspended ticket X
Delete X
Suspended tickets List suspended tickets X
Show suspended ticket X
Suspended ticket attachments X
Delete multiple suspended tickets X
Export suspended tickets X
Recover multiple suspended tickets X
Target failures List target failures X
Show target failure X
Targets List targets X
Show target X
Create X
Update X
Delete X
Ticket activities List activities X
Show activity X
Ticket audit Change a comment from public to private X
Ticket audits List all ticket audits X
List audits for a ticket X
Show audit X
Count audits for a ticket X
Ticket comments List comments X
Redact chat comment attachment X
Redact chat comment X
Redact ticket comment in agent workspace X
Count ticket comments X
Redact string in comment X
Make comment private X
Ticket content pins List ticket content pins X
Create ticket content pin X
Delete content pin from ticket X
Ticket fields List ticket fields X
Show ticket field X
List ticket field options X
Show a ticket field option X
Create X
Create or update a ticket field option X
Update X
Delete X
Delete ticket field option X
Create or update ticket field option X
Count ticket fields X
Reorder ticket fields X
Ticket form statuses Create ticket form statuses for a custom status X
List ticket form statuses X
Show many ticket form statuses X
Delete ticket form statuses X
Delete ticket form status by ID X
Ticket forms List ticket forms X
Show ticket form X
Show many ticket forms X
Create X
Clone an already existing ticket form X
Update X
Reorder ticket forms X
Delete X
List ticket form statuses of a ticket form X
Create ticket form statuses X
Bulk update ticket form statuses of a ticket form X
Update ticket form status by ID X
Show many ticket forms X
Ticket import Create ticket import X
Ticket bulk import X
Ticket metric events List ticket metric events X
Ticket metrics List ticket metrics X
Show ticket metrics X
Show metrics of a specific ticket X
Ticket skips List skips for the current account X
List ticket skips X
Create skip for the current user X
Tickets List tickets X
List deleted tickets X
List tickets by external ID X
Export tickets of an organization X
Export tickets requested by an user X
Export tickets where an user is one of the collaborators X
Export tickets which are assigned to the user X
Export tickets are recently viewed by the agent requesting for X
Show ticket X
Show multiple tickets X
Ticket related information X
List collaborators for a ticket X
Listing ticket incidents X
List followers for a ticket X
List email ccs for a ticket X
Listing ticket problems X
Search API for tickets X
Create X
Update X
Delete X
Delete ticket permanently X
Restore a previously deleted ticket X
Delete multiple tickets permanently X
Restore previously deleted tickets in bulk X
Autocomplete problems X
Mark ticket as spam and suspend requester X
Merge tickets into target ticket X
Count tickets X
Create many tickets X
Bulk delete tickets X
Bulk mark tickets as spam X
Update many tickets X
Trigger categories List ticket trigger categories X
Create ticket trigger category X
Show ticket trigger category X
Update ticket trigger category X
Delete ticket trigger category X
Create batch job for ticket trigger categories X
Triggers List triggers X
Getting triggers X
List trigger revisions X
Getting revisions X
Search triggers X
List trigger action and condition definitions X
List active triggers X
Create X
Update X
Update many triggers X
Reorder triggers X
Delete X
Bulk delete triggers X
Bulk delete ticket triggers X
Twitter channel Create ticket from tweet X
User fields List user fields X
Show user field X
List user field options X
Show a user field option X
Create X
Create or update a user field option X
Update X
Delete X
Delete user field option X
Create or update a user field option X
Reorder user field X
User identities List identities X
Shows identity X
Create X
Create end user identity X
Update X
Make identity primary X
Make end user identity primary X
Verify identity X
Delete X
Request user verification X
User passwords Set a user's password X
Change your password X
Views List views X
List views by ID X
Get view count X
Export view X
Get view counts X
List tickets from a view X
Execute view X
List views compact X
Show view X
Search views X
List active views X
Create X
Preview count X
Previewing views X
Update X
Delete X
Bulk delete views X
Count views X
Count tickets in views X
Bulk delete views X
List views by ID X
Update many views X
Visit outcomes Retrieve all visit outcomes X
Workspaces List workspaces X
Create workspace X
Show workspace X
Update workspace X
Delete workspace X
Bulk delete workspaces X
Reorder workspaces X
X channel List monitored x handles X
Show monitored x handle X
Create ticket from tweet X
List ticket statuses X

Zendesk Sell APIs

Resource API endpoint Export Import
Account Retrieve account details X
Associated contacts Retrieve deal's associated contacts X
Create an associated contact X
Remove an associated contact X
Call outcomes Retrieve all call outcomes X
Calls Retrieve all calls X
Retrieve a single call X
Create a call X
Update a call X
Delete a call X
Collaborations Retrieve all collaborations X
Retrieve a single collaboration X
Create a collaboration X
Delete a collaboration X
Contacts Retrieve all contacts X
Retrieve a single contact X
Create a contact X
Update a contact X
Delete a contact X
Custom fields Retrieve all custom fields X
Deal sources Retrieve all sources X
Retrieve a single source X
Create a source X
Update a source X
Delete a source X
Deal unqualified reasons Retrieve all deal unqualified reasons X
Retrieve a single deal unqualified reason X
Create a deal unqualified reason X
Update a deal unqualified reason X
Delete a deal unqualified reason X
Deals Retrieve all deals X
Retrieve a single deal X
Create a deal X
Update a deal X
Delete a deal X
Documents Retrieve documents X
Retrieve a single document X
Lead sources Retrieve all sources X
Retrieve a single source X
Create a source X
Update a source X
Delete a source X
Leads Retrieve all leads X
Retrieve a single lead X
Create a lead X
Update a lead X
Delete a lead X
Line items Retrieve order's line items X
Retrieve a single line item X
Create a line item X
Remove a line item X
Loss reasons Retrieve all reasons X
Retrieve a single reason X
Create a loss reason X
Update a loss reason X
Delete a loss reason X
Notes Retrieve all notes X
Retrieve a single note X
Create a note X
Update a note X
Delete a note X
Orders Retrieve all orders X
Retrieve a single order X
Create an order X
Update an order X
Delete an order X
Pipelines Retrieve all pipelines X
Products Retrieve all products X
Retrieve a single product X
Create a product X
Update a product X
Delete a product X
Stages Retrieve all stages X
Tags List tags X
Show tags X
Autocomplete tags X
Set tags X
Add tags X
Delete X
Count tags X
List resource tags X
Retrieve all tags X
Retrieve a single tag X
Create a tag X
Update a tag X
Delete a tag X
Tasks Retrieve all tasks X
Retrieve a single task X
Create a task X
Update a task X
Delete a task X
Text messages Retrieve all text messages X
Retrieve a single text message X
Users List users X
Show user X
Show many users X
User related information X
Search users X
Autocomplete users X
List deleted users X
Show deleted user X
Show compliance deletion statuses X
Get a list of password requirements X
Show the currently authenticated user X
Create X
Update X
Delete X
Permanently delete user X
Count deleted users X
Merge end users X
Count users X
Create many users X
Create or update user X
Create or update many users X
Bulk delete users X
Logout many users X
Request user create X
Update many users X
Retrieve all users X
Retrieve a single user X
Retrieve an authenticating user X
Visits Retrieve all visits X

Available DI objects

The following objects are available when using Zendesk as a source in Celigo Data Integration (DI).

Primary key: Zendesk assigns a unique numeric id to each object.

Object API endpoint Available extract modes Delta field
Audit logs Listing audit logs Full
Group memberships List memberships Full
Groups List groups Full
Organization memberships List memberships Full
Organization subscriptions List organization subscriptions Full
Organizations Incremental organization export Full, Incremental start_time
Satisfaction ratings List satisfaction ratings Full, Incremental start_time
Satisfaction reasons List reasons for satisfaction rating Full
Suspended tickets List suspended tickets Full
Ticket activities List activities Full, Incremental since
Ticket audits List all ticket audits Full
Ticket metric events List ticket metric events Full, Incremental start_time
Ticket metrics List ticket metrics Full
Tickets Incremental ticket export (cursor-based) Full, Incremental start_time
Users Incremental user export (cursor-based) Full, Incremental start_time

Response schemas

Click an object below to view its response fields and delta configuration.

Audit logs — Listing audit logs

Response schema:

Field Type
id number (Primary key)
timestamp string
method string
url string
user_id number
ip_address string
authorization_type string
client string
referer string
bytes_sent number
status number
category string
summary string
graphql object
Group memberships — List memberships

Response schema:

Field Type
id number (Primary key)
user_id number
group_id number
default boolean
created_at string
updated_at string
url string
Groups — List groups

Response schema:

Field Type
id number (Primary key)
name string
description string
created_at string
updated_at string
Organization memberships — List memberships

Response schema:

Field Type
created_at string
default boolean
id number (Primary key)
organization_id number
organization_name string
updated_at string
url string
user_id number
view_tickets boolean
Organization subscriptions — List organization subscriptions

Response schema:

Field Type
id number (Primary key)
organization_id number
user_id number
kind string
created_at string
updated_at string
Organizations — Incremental organization export

Delta configuration: use it to request incremental data.

Setting Value
Delta filter start_time = {{{lastExportDateTime}}}
Date format X

Response schema:

Field Type
id number (Primary key)
url string
external_id string
name string
created_at string
updated_at string
domain_names stringarray
details string
notes string
group_id number
shared_tickets boolean
shared_comments boolean
tags stringarray
organization_fields object
Satisfaction ratings — List satisfaction ratings

Delta configuration: use it to request incremental data.

Setting Value
Delta filter start_time = {{{lastExportDateTime}}}
Date format X

Response schema:

Field Type
id number (Primary key)
assignee_id number
group_id number
requester_id number
ticket_id number
score string
comment string
reason string
reason_id number
created_at string
updated_at string
url string
Satisfaction reasons — List reasons for satisfaction rating

Response schema:

Field Type
id number (Primary key)
raw_value string
value string
default_value boolean
created_at string
updated_at string
Suspended tickets — List suspended tickets

Response schema:

Field Type
id number (Primary key)
author object
author.id number
author.email string
author.name string
subject string
content string
cause string
ticket_id number
recipient string
created_at string
updated_at string
url string
via object
via.channel string
via.source object
Ticket activities — List activities

Delta configuration: use it to request incremental data.

Setting Value
Delta filter since = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id number (Primary key)
actor_id number
actor object
actor.id number
actor.name string
actor.active boolean
verb string
target object
target.id number
target.title string
target.type string
created_at string
updated_at string
title string
url string
user object
user.id number
user.name string
user.photo object
user.agent boolean
user.organization_id number
Ticket audits — List all ticket audits

Response schema:

Field Type
id number (Primary key)
ticket_id number
created_at string
author_id number
events objectarray
events.id number
events.type string
events.field_name string
events.value string
events.previous_value string
via object
via.channel string
via.source object
via.source.from object
via.source.to object
via.source.rel string
metadata object
metadata.system object
metadata.custom object
Ticket metric events — List ticket metric events

Delta configuration: use it to request incremental data.

Setting Value
Delta filter start_time = {{{lastExportDateTime}}}
Date format X

Response schema:

Field Type
id number (Primary key)
instance_id number
metric string
ticket_id number
time string
type string
deleted boolean
sla object
sla.calendar number
sla.business number
group_sla object
group_sla.calendar number
group_sla.business number
status object
status.calendar number
status.business number
Ticket metrics — List ticket metrics

Response schema:

Field Type
id number (Primary key)
ticket_id number
created_at string
updated_at string
group_stations number
assignee_stations number
reopens number
replies number
reply_time_in_minutes object
reply_time_in_minutes.calendar number
reply_time_in_minutes.business number
full_resolution_time_in_minutes object
full_resolution_time_in_minutes.calendar number
full_resolution_time_in_minutes.business number
agent_wait_time_in_minutes object
agent_wait_time_in_minutes.calendar number
agent_wait_time_in_minutes.business number
requester_wait_time_in_minutes object
requester_wait_time_in_minutes.calendar number
requester_wait_time_in_minutes.business number
on_hold_time_in_minutes object
on_hold_time_in_minutes.calendar number
on_hold_time_in_minutes.business number
first_resolution_time_in_minutes object
first_resolution_time_in_minutes.calendar number
first_resolution_time_in_minutes.business number
latest_comment_added_at string
assigned_at string
initially_assigned_at string
solved_at string
requester_updated_at string
status_updated_at string
Tickets — Incremental ticket export (cursor-based)

Delta configuration: use it to request incremental data.

Setting Value
Delta filter start_time = {{{lastExportDateTime}}}
Date format X

Response schema:

Field Type
id number (Primary key)
url string
external_id string
type string
subject string
raw_subject string
description string
priority string
status string
recipient string
requester_id number
submitter_id number
assignee_id number
organization_id number
group_id number
collaborator_ids numberarray
follower_ids numberarray
email_cc_ids numberarray
forum_topic_id number
problem_id number
has_incidents boolean
is_public boolean
due_at string
tags stringarray
custom_fields objectarray
custom_fields.id number
custom_fields.value string
satisfaction_rating object
satisfaction_rating.id number
satisfaction_rating.score string
satisfaction_rating.comment string
sharing_agreement_ids numberarray
fields objectarray
fields.id number
fields.value string
followup_ids numberarray
brand_id number
allow_channelback boolean
allow_attachments boolean
from_messaging_channel boolean
ticket_form_id number
custom_status_id number
created_at string
updated_at string
generated_timestamp string
via object
via.channel string
via.source object
via.source.from object
via.source.from.id string
via.source.from.title string
via.source.from.address string
via.source.to object
via.source.to.name string
via.source.to.address string
Users — Incremental user export (cursor-based)

Delta configuration: use it to request incremental data.

Setting Value
Delta filter start_time = {{{lastExportDateTime}}}
Date format X

Response schema:

Field Type
id number (Primary key)
url string
name string
email string
alias string
active boolean
chat_only boolean
custom_role_id number
default_group_id number
details string
external_id string
iana_time_zone string
last_login_at string
locale string
locale_id number
moderator boolean
notes string
only_private_comments boolean
organization_id number
phone string
shared_phone_number boolean
report_csv boolean
restricted_agent boolean
role string
role_type number
shared boolean
shared_agent boolean
signature string
suspended boolean
suspension_details object
tags stringarray
ticket_restriction string
time_zone string
two_factor_auth_enabled boolean
verified string
user_fields object
created_at string
updated_at string