| Label |
Name |
Description |
| Read Tickets (All) |
get_tickets |
Get a list of all tickets in your account [API Help..] |
| Read Tickets (Incremental) changed after a specified date |
get_tickets_incr |
Get a list of tickets changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [API Help..] |
| Read Users (Incremental) changed after a specified date |
get_users_incr |
Get a list of users changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [API Help..] |
| Read Organizations (Incremental) changed after a specified date |
get_organizations_incr |
Get a list of organizations changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [API Help..] |
| Read Ticket Events (Incremental) changed after a specified date |
get_ticket_events_incr |
Returns a list of ticket events changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [API Help..] |
| Read Ticket Metric Events (Incremental) changed after a specified date |
get_ticket_metric_events_incr |
Get a list of Ticket Metric Events changed after a specified date/time. If you use this endpoint to read data and insert to destination like SSIS Upsert Destination (ZappySys Product) then make sure you do not select delete option on Upsert UI. Only choose Update + Insert for Incremental fetch. [API Help..] |
| Read Ticket(s) by ID |
get_tickets_by_ids |
Get a list of all tickets in your account [API Help..] |
| Read User(s) by ID |
get_users_by_ids |
Get a list of users in your account for specific id(s) [API Help..] |
| Read Organization(s) by ID |
get_organizations_by_ids |
Get a list of organizations in your account for specific id(s) [API Help..] |
| Read Tickets for Organization |
get_tickets_by_org |
Get all tickets for specified organization_id [API Help..] |
| Read Tickets for User (Requested) |
get_tickets_for_user_requested |
Get all requested tickets for specified user_id [API Help..] |
| Read Tickets for User (CCed) |
get_tickets_for_user_cced |
Get all CCed tickets for specified user_id [API Help..] |
| Read Tickets for User (Assigned) |
get_tickets_for_user_assigned |
Get all assigned tickets for specified user_id [API Help..] |
| Read Tickets (Recent) |
get_tickets_recent |
Get all recent tickets [API Help..] |
| Read Tickets Count (All) |
get_tickets_count |
Returns an approximate count of tickets in the account. If the count exceeds 100,000, it is updated every 24 hours. The count[refreshed_at] property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, count[refreshed_at] may occasionally be null. This indicates that the count is being updated in the background, and count[value] is limited to 100,000 until the update is complete. [API Help..] |
| Read Tickets Count (for Organization) |
get_tickets_count_org |
Returns an approximate count of tickets for specified organization_id. If the count exceeds 100,000, it is updated every 24 hours. The count[refreshed_at] property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, count[refreshed_at] may occasionally be null. This indicates that the count is being updated in the background, and count[value] is limited to 100,000 until the update is complete. [API Help..] |
| Read Ticket Metrics |
get_ticket_metrics |
Returns a list of tickets with their metrics. [API Help..] |
| Read Ticket Fields |
get_ticket_fields |
Returns a list of all system and custom ticket fields in your account. For accounts without access to multiple ticket forms, positions can be changed using the Update Ticket Field endpoint or the Ticket Forms page in Zendesk Support (Admin > Manage > Ticket Forms). The Ticket Forms page shows the fields for the account. The order of the fields is used in the different products to show the field values in the tickets. [API Help..] |
| Read Ticket Forms |
get_ticket_forms |
Returns a list of all ticket forms for your account if accessed as an admin or agent. End users only see ticket forms that have end_user_visible set to true. [API Help..] |
| Read Ticket Comments |
get_ticket_comments |
Returns comments for specified ticket ID. [API Help..] |
| Read Ticket Attachments |
get_ticket_attachments |
Returns attachments for the specified Ticket ID. [API Help..] |
| Read Ticket ActivityStream |
get_ticket_activity_stream |
Lists ticket activities in the last 30 days affecting the agent making the request. The Ticket Activities API returns ticket activities by other people affecting the agent making the API request. Ticket activities include assigning a ticket to the agent, increasing the priority of a ticket assigned to the agent, or adding a comment to a ticket assigned to the agent. A possible use case for the API is building a personalized notification service for agents. [API Help..] |
| Read Ticket ActivityStream Details |
get_ticket_activity_info |
Lists ticket activity details. [API Help..] |
| Search Records - WITH Sorting and Extra Columns (Max 1000 rows) |
get_search |
Search for ticket, user, organization, or group for specified search criteria. Returns max 1000 records based on search criteria (i.e. query) you specify [API Help..] |
| Search Records - NO Sorting (Allows more than 1000 rows) |
get_search_export |
Search for ticket, user, organization, or group for specified search criteria. Sorting not allowed but you can get more than 1000 records unlike other endpoint for search which supports max 1000 rows but allows sorting if needed. [API Help..] |
| Read Organization Count |
get_organizations_count |
Get organizations count. [API Help..] |
| Read Organization Fields |
get_organization_fields |
Returns a list of custom Organization Fields in your account. Fields are returned in the order that you specify in your Organization Fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each Organization Field to the values returned under the organization_fields attribute on the Organization resource. [API Help..] |
| Read Tags |
get_tags |
Lists the 500 most popular tags in the last 60 days, in decreasing popularity. You must enable the tagging of users and organizations in Zendesk Support for the API calls to work. Select Manage > Settings > Customers, and enable the option. [API Help..] |
| Read Groups |
get_groups |
Get information about groups. [API Help..] |
| Read User Fields |
get_user_fields |
Returns a list of custom User Fields in your account. Fields are returned in the order that you specify in your User Fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each User Field to the values returned under the user_fields attribute on the User resource. [API Help..] |
| Read Current User Info |
get_me |
Get information for current profile based on credentials you have used. [API Help..] |
| Read Brands |
get_brands |
Get information about brands. [API Help..] |
| Read Views |
get_views |
Get information about views. [API Help..] |
| Read Macros |
get_macros |
Get information about macros. [API Help..] |
| Read Sessions |
get_sessions |
Get information about Sessions. [API Help..] |
| Read User Sessions |
get_user_sessions |
Get information about user sessions. [API Help..] |
| Read Requests |
get_requests |
Returns a list of requests. [API Help..] |
| Read Requests Search |
get_requests_search |
Returns a requests using search criteria. [API Help..] |
| Read Attachment |
get_attachment |
Read attachment information [API Help..] |
| Delete Attachment |
delete_attachment |
Delete attachment [API Help..] |
| Upload Attachment (Single file) |
post_attachment |
Upload files to Zendesk which can be used as attachment later. [API Help..] |
| Delete Upload Session |
delete_upload |
Delete upload session and all its attachments. [API Help..] |
| Create Ticket (Single) |
post_ticket |
Creates one ticket at a time and wait until its created. Use BULK Table instead of this one to create multiple tickets. [API Help..] |
| Create Tickets (Bulk) |
post_tickets |
Create tickets in bulk (job is queued) and wait until done. This is faster than one request at a time [API Help..] |
| Delete Tickets (Bulk) |
delete_tickets |
Delete multiple tickets in a single request. This is faster than row by row operation. [API Help..] |
| Update Tickets (Bulk) |
put_tickets |
Update tickets in bulk (job is queued) and wait until done. This is faster than one request at a time [API Help..] |
| Update Ticket (Single) |
put_ticket |
Update single ticket. Use bulk operation if you pfrefer to update multiple tickets. If you like to set additional_tags or remove_tags then use BULK Table (Tickets) [API Help..] |
| Delete Ticket |
delete_ticket |
Delete ticket by id. [API Help..] |
| Read Users (All) |
get_users |
Get a list of all users in your account [API Help..] |
| Read Organizations (All) |
get_organizations |
Get a list of all organizations in your account [API Help..] |
| Upsert Users (Bulk) - Create or Update |
upsert_users |
Create or Update users in bulk (Upsert) [API Help..] |
| Delete User |
delete_user |
Delete a user by its id [API Help..] |
| Update User |
put_user |
Update a user by its id [API Help..] |
| Create User |
post_user |
Create a user [API Help..] |
| Upsert User - Create or Update |
upsert_user |
Create or Update a user in (Upsert) [API Help..] |
| Delete Organization |
delete_organization |
Delete an organization by its id [API Help..] |
| Update Organization |
put_organization |
Update an organization by its id [API Help..] |
| Create Organization |
post_organization |
Create an organization [API Help..] |
| Upsert Organization - Create or Update |
upsert_organization |
Create or Update an organization in (Upsert) [API Help..] |
| Generic Request |
generic_request |
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. |
