EndPoints for Zendesk Connector
On this page you will see possible API actions you can perform with Zendesk connector. We will refer this as API EndPoint or just EndPoint.
| Label | Name | Description |
|---|---|---|
| Read Tickets (All) | get_tickets | Get a list of all tickets in your account [API reference] |
| 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 reference] |
| 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 reference] |
| 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 reference] |
| 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 reference] |
| 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 reference] |
| Read Ticket(s) by ID | get_tickets_by_ids | Get a list of all tickets in your account [API reference] |
| Read User(s) by ID | get_users_by_ids | Get a list of users in your account for specific id(s) [API reference] |
| Read Organization(s) by ID | get_organizations_by_ids | Get a list of organizations in your account for specific id(s) [API reference] |
| Read Tickets for Organization | get_tickets_by_org | Get all tickets for specified organization_id [API reference] |
| Read Tickets for User (Requested) | get_tickets_for_user_requested | Get all requested tickets for specified user_id [API reference] |
| Read Tickets for User (CCed) | get_tickets_for_user_cced | Get all CCed tickets for specified user_id [API reference] |
| Read Tickets for User (Assigned) | get_tickets_for_user_assigned | Get all assigned tickets for specified user_id [API reference] |
| Read Tickets (Recent) | get_tickets_recent | Get all recent tickets [API reference] |
| 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 reference] |
| 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 reference] |
| Read Ticket Metrics | get_ticket_metrics | Returns a list of tickets with their metrics. [API reference] |
| 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 reference] |
| 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 reference] |
| Read Ticket Comments | get_ticket_comments | Returns comments for specified ticket ID. [API reference] |
| Read Ticket Attachments | get_ticket_attachments | Returns attachments for the specified Ticket ID. [API reference] |
| 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 reference] |
| Read Ticket ActivityStream Details | get_ticket_activity_info | Lists ticket activity details. [API reference] |
| 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 reference] |
| 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 reference] |
| Read Organization Count | get_organizations_count | Get organizations count. [API reference] |
| 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 reference] |
| 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 reference] |
| Read Groups | get_groups | Get information about groups. [API reference] |
| 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 reference] |
| Read Current User Info | get_me | Get information for current profile based on credentials you have used. [API reference] |
| Read Brands | get_brands | Get information about brands. [API reference] |
| Read Views | get_views | Get information about views. [API reference] |
| Read Macros | get_macros | Get information about macros. [API reference] |
| Read Sessions | get_sessions | Get information about Sessions. [API reference] |
| Read User Sessions | get_user_sessions | Get information about user sessions. [API reference] |
| Read Requests | get_requests | Returns a list of requests. [API reference] |
| Read Requests Search | get_requests_search | Returns a requests using search criteria. [API reference] |
| Read Attachment | get_attachment | Read attachment information [API reference] |
| Delete Attachment | delete_attachment | Delete attachment [API reference] |
| Upload Attachment (Single file) | post_attachment | Upload files to Zendesk which can be used as attachment later. [API reference] |
| Delete Upload Session | delete_upload | Delete upload session and all its attachments. [API reference] |
| 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 reference] |
| 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 reference] |
| Delete Tickets (Bulk) | delete_tickets | Delete multiple tickets in a single request. This is faster than row by row operation. [API reference] |
| 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 reference] |
| 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 reference] |
| Delete Ticket | delete_ticket | Delete ticket by id. [API reference] |
| Read Users (All) | get_users | Get a list of all users in your account [API reference] |
| Read Organizations (All) | get_organizations | Get a list of all organizations in your account [API reference] |
| Upsert Users (Bulk) - Create or Update | upsert_users | Create or Update users in bulk (Upsert) [API reference] |
| Delete User | delete_user | Delete a user by its id [API reference] |
| Update User | put_user | Update a user by its id [API reference] |
| Create User | post_user | Create a user [API reference] |
| Upsert User - Create or Update | upsert_user | Create or Update a user in (Upsert) [API reference] |
| Delete Organization | delete_organization | Delete an organization by its id [API reference] |
| Update Organization | put_organization | Update an organization by its id [API reference] |
| Create Organization | post_organization | Create an organization [API reference] |
| Upsert Organization - Create or Update | upsert_organization | Create or Update an organization in (Upsert) [API reference] |
| 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. |
| Generic Request (Bulk Write) | generic_request_bulk_write | This is a generic endpoint for bulk write purpose. 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. |