Zendesk Ticketing API Integration Vol.1

These are the list of integration use cases supported by Knit for Zendesk Ticketing API as part of the TICKETING category

Delete a Brand

ID: delete_a_brand
Operation: write
Entities: admin, brand
Summary: The 'Delete a Brand' API endpoint allows administrators to delete a brand by specifying the brand's ID in the path parameters. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the brand has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Sharing Agreement

ID: delete_a_sharing_agreement
Operation: write
Entities: sharing agreement
Summary: The 'Delete a Sharing Agreement' API endpoint allows administrators to delete a specific sharing agreement by providing the sharing agreement ID in the path parameters. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the sharing agreement has been successfully deleted and there is no additional content in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete App

ID: delete_app
Operation: write
Entities: app
Summary: The Delete App API allows administrators to delete a specified app from Zendesk Support. The API requires the app_id as a path parameter to identify the app to be deleted. The request must include an Authorization header with a basic authentication token. Upon successful deletion, the API returns a 204 No Content status, indicating that the app has been removed from the My Apps page in Zendesk Support.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Attribute

ID: delete_attribute
Operation: write
Entities: attribute, routing, admin
Summary: The Delete Attribute API allows administrators to delete a skill-based routing attribute by specifying its ID in the path parameters. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a 204 No Content response, indicating that the attribute has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Attribute Value

ID: delete_attribute_value
Operation: write
Entities: agent, value, attribute
Summary: The Delete Attribute Value API allows agents to delete a specific skill-based routing attribute value by providing the attribute ID and the attribute value ID as path parameters. The request requires basic authentication. Upon successful deletion, the API returns a 204 No Content status, indicating that the attribute value has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete the Authenticated Session

ID: delete_authenticated_session
Operation: write
Entities: user, session, authentication
Summary: The 'Delete the Authenticated Session' API endpoint allows the deletion of the current session for authenticated users. This is applicable when using session authentication, such as client-side requests from a Zendesk app. It is not effective when using OAuth or basic authentication as there is no current session in those cases. The endpoint is accessible to Admins, Agents, and End users. The request requires a basic authentication token in the headers. A successful request returns a 204 No Content status, indicating the session has been deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Automation

ID: delete_automation
Operation: write
Entities: agent, automation
Summary: The Delete Automation API allows agents to delete an automation by its ID. The endpoint is DELETE /api/v2/automations/{automation_id}. The request requires the 'automation_id' as a path parameter, which is the ID of the automation to be deleted. The request header must include 'Content-Type: application/json'. The response is a 204 No Content status, indicating that the automation was successfully deleted. Note that some default automations may be restricted from deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Bookmark

ID: delete_bookmark
Operation: write
Entities: agent, bookmark
Summary: The Delete Bookmark API allows agents to delete their own bookmarks by specifying the bookmark ID in the path parameters. The request requires basic authentication using an email address and API token. If the bookmark exists and is successfully deleted, the API returns a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Automations

ID: delete_bulk_delete_automations
Operation: write
Entities: agent, automation
Summary: The Bulk Delete Automations API allows agents to delete multiple automations at once by providing a comma-separated list of automation IDs. The DELETE request requires an 'ids' query parameter, which is an array of automation IDs to be deleted. The request must include an Authorization header with a basic authentication token. If the request is successful, the API returns a 204 No Content response, indicating that the specified automations have been deleted. Note that some default automations may not be deletable, and if included in the request, only the unrestricted automations will be deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Macros

ID: delete_bulk_delete_macros
Operation: write
Entities: macro
Summary: The Bulk Delete Macros API allows agents to delete multiple macros at once by providing a comma-separated list of macro IDs in the query parameters. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the specified macros have been deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Organizations

ID: delete_bulk_delete_organizations
Operation: write
Entities: organization, job status, role
Summary: The Bulk Delete Organizations API allows admins and agents with appropriate permissions to delete multiple organizations in a single request. The API accepts a comma-separated list of up to 100 organization ids or external ids as query parameters. The response returns a job_status JSON object and queues a background job to perform the deletions. Users can check the status of the job using the Show Job Status endpoint. The API is restricted to admins and agents with custom roles that have permissions to manage organizations.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Tickets

ID: delete_bulk_delete_tickets
Operation: write
Entities: agent, ticket, job
Summary: The Bulk Delete Tickets API allows admins and agents with the appropriate permissions to delete multiple tickets at once by providing a comma-separated list of ticket IDs. The API queues a background job to perform the deletion and returns a job_status JSON object. Users can check the status of the job using the provided URL. The API requires an authorization header for authentication and the 'ids' query parameter is mandatory.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Views

ID: delete_bulk_delete_views
Operation: write
Entities: agent, view
Summary: The Bulk Delete Views API allows agents to delete multiple views by providing a list of view IDs. The request requires authentication via email and API token. The 'ids' query parameter is mandatory and should contain the IDs of the views to be deleted, separated by commas. Upon successful deletion, the API returns a 204 No Content status, indicating that the views have been deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Workspaces

ID: delete_bulk_delete_workspaces
Operation: write
Entities: admin, workspace
Summary: The Bulk Delete Workspaces API allows admins to delete multiple workspaces at once by specifying their IDs in the query parameters. The request requires basic authentication using an email and API token. The API endpoint is '/api/v2/workspaces/destroy_many' and it uses the DELETE method. The 'ids' query parameter is mandatory and should be an array of workspace IDs to be deleted. On successful deletion, the API returns a 200 OK status with no content in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Group Memberships

ID: delete_bulk_group_memberships
Operation: write
Entities: user, ticket, group
Summary: The Bulk Delete Group Memberships API allows admins and agents with appropriate permissions to remove multiple users from groups in a single request. It also schedules a job to unassign all working tickets assigned to the specified user and group combinations. The API accepts an optional query parameter 'ids' which is a comma-separated list of group membership IDs to delete. The response includes a job status object detailing the progress and results of the deletion operation.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Organization Memberships

ID: delete_bulk_organization_memberships
Operation: write
Entities: user, ticket, organization membership
Summary: The Bulk Delete Organization Memberships API allows agents to immediately remove users from an organization and schedule a job to unassign all working tickets currently assigned to the user and organization combination. The organization_id of the unassigned tickets is set to null. The API accepts an optional query parameter 'ids', which is an array of organization membership IDs to delete. The response returns a job_status JSON object and queues a background job to perform the deletions. The job status can be checked using the provided URL in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Ticket Triggers

ID: delete_bulk_ticket_triggers
Operation: write
Entities: agent, trigger
Summary: The Bulk Delete Ticket Triggers API allows agents to delete multiple ticket triggers at once by providing a comma-separated list of trigger IDs in the query parameter 'ids'. The API requires authentication via a basic auth token. Upon successful deletion, the API returns a 204 No Content status, indicating that the specified triggers have been deleted without returning any content in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete User Sessions

ID: delete_bulk_user_sessions
Operation: write
Entities: user, session
Summary: The Bulk Delete User Sessions API allows admins, agents, and end users to delete all sessions for a specified user. The API requires the user_id as a path parameter, which is mandatory. The request must include an Authorization header with a basic authentication token. Upon successful deletion, the API returns a 204 No Content status, indicating that all sessions for the user have been deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Bulk Delete Users

ID: delete_bulk_users
Operation: write
Entities: user, job status, admin
Summary: The Bulk Delete Users API allows administrators to delete multiple users at once by providing a comma-separated list of user IDs or external IDs as query parameters. The API accepts either 'ids' or 'external_ids' as query parameters, both of which are optional. The request is authenticated using a basic authentication token. Upon successful request, the API returns a job_status JSON object and queues a background job to perform the deletion. The response includes details such as job ID, completion message, progress, results of each deletion action, and a URL to check the job status. This API is useful for managing user accounts in bulk, especially when dealing with large numbers of users.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Custom Role

ID: delete_custom_role
Operation: write
Entities: agent, custom role, administrator
Summary: The Delete Custom Role API allows administrators and agents with the manage_roles permission to delete a custom agent role in accounts on the Enterprise plan or above. The API requires the custom_role_id as a path parameter to specify which custom role to delete. Authentication is done via basic authentication using an email address and API token. A successful request returns a 204 No Content status, indicating that the role has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Deletion Schedule

ID: delete_deletion_schedule
Operation: write
Entities: deletion schedule, admin
Summary: The Delete Deletion Schedule API allows admins to delete a deletion schedule by its ID. The API requires the deletion_schedule_id as a path parameter, which is mandatory. The request must include an Authorization header with a basic authentication token. Upon successful deletion, the API returns a 204 No Content response, indicating that the deletion schedule has been successfully removed and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Dynamic Content Item

ID: delete_dynamic_content_item
Operation: write
Entities: agent, admin, dynamic content item
Summary: The Delete Dynamic Content Item API allows Admins and Agents to delete a specific dynamic content item identified by its ID. The API requires the dynamic_content_item_id as a path parameter and uses basic authentication with an email address and API token. Upon successful deletion, the API returns a 204 No Content status with no response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Dynamic Content Variant

ID: delete_dynamic_content_variant
Operation: write
Entities: variant, admin, dynamic content item
Summary: The Delete Dynamic Content Variant API allows Admins and Agents to delete a specific variant of a dynamic content item. The API requires the dynamic content item ID and the variant ID as path parameters. The request must be authenticated using a basic authentication token. Upon successful deletion, the API returns a 204 No Content status, indicating that the variant has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Group

ID: delete_group
Operation: write
Entities: agent, group, admin
Summary: The Delete Group API allows admins and agents with the appropriate permissions to delete a group by its ID. The API requires the group_id as a path parameter, which is mandatory. The request must include an Authorization header with a basic authentication token. Upon successful deletion, the API returns a 204 No Content status, indicating that the group has been deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Group Membership

ID: delete_group_membership
Operation: write
Entities: group membership, ticket, user
Summary: The Delete Group Membership API immediately removes a user from a group and schedules a job to unassign all working tickets that are assigned to the given user and group combination. This API is accessible to Admins and Agents assigned to a custom role with permissions to manage group memberships (Enterprise only). It requires the 'group_membership_id' and 'user_id' as path parameters. The API returns a 204 No Content status upon successful deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Group SLA Policy

ID: delete_group_sla_policy
Operation: write
Entities: group SLA policy, admin, parameter
Summary: The Delete Group SLA Policy API allows administrators to delete a specific Group SLA policy by providing the group_sla_policy_id as a path parameter. The request requires authentication using an email and API token, and the Content-Type header must be set to application/json. Upon successful deletion, the API returns a 204 No Content response, indicating that the operation was successful and no content is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Holiday

ID: delete_holiday
Operation: write
Entities: holiday, admin, schedule
Summary: The 'Delete Holiday' API allows administrators to delete a specific holiday from a schedule. It requires the schedule ID as a mandatory path parameter and the holiday ID as an optional path parameter. The request is made using the DELETE method and requires the 'Content-Type' header to be set to 'application/json'. Upon successful deletion, the API returns a 204 No Content response, indicating that the holiday has been successfully removed from the schedule.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Macro

ID: delete_macro
Operation: write
Entities: agent, macro
Summary: The Delete Macro API allows agents to delete a specific macro by its ID. The endpoint requires the macro_id as a path parameter, which is mandatory. The request must include an Authorization header with a basic authentication token. Upon successful deletion, the API returns a 204 No Content status, indicating that the macro has been deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Multiple Suspended Tickets

ID: delete_multiple_suspended_tickets
Operation: write
Entities: agent, admin, suspended ticket
Summary: The 'Delete Multiple Suspended Tickets' API allows admins and agents with appropriate permissions to delete multiple suspended tickets in Zendesk. The API accepts a DELETE request to the endpoint '/api/v2/suspended_tickets/destroy_many' with a required query parameter 'ids', which is a comma-separated list of up to 100 auto-generated ids of the suspended tickets to be deleted. The request must include an 'Authorization' header for authentication. On successful execution, the API returns a 204 No Content status, indicating that the specified suspended tickets have been successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Multiple Tickets Permanently

ID: delete_multiple_tickets_permanently
Operation: write
Entities: agent, ticket, job status
Summary: The 'Delete Multiple Tickets Permanently' API endpoint allows agents to permanently delete up to 100 soft-deleted tickets by providing a comma-separated list of ticket IDs. This operation enqueues a deletion job and returns a job_status JSON object indicating the job's status. The endpoint is subject to its own rate limits, and usage information is provided in the response headers. If a ticket fails to be deleted, the endpoint continues to attempt deletion of the remaining tickets. The operation cannot be undone, and the job's completion status can be checked using the Show Job Status endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

Delete OAuth Client

ID: delete_oauth_client
Operation: write
Entities: admin, oauth client
Summary: The Delete OAuth Client API allows administrators to delete an OAuth client by specifying its ID in the path parameter. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Organization

ID: delete_organization
Operation: write
Entities: agent, organization, admin
Summary: The Delete Organization API allows admins and agents with the appropriate permissions to delete an organization by its ID. The request requires a path parameter 'organization_id' which is the ID of the organization to be deleted. The API uses basic authentication with an email address and API token. A successful request returns a 204 No Content status, indicating that the organization has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Organization Field

ID: delete_organization_field
Operation: write
Entities: field, organization
Summary: The Delete Organization Field API allows admins to delete an organization field by specifying its ID or key in the path parameters. The request requires basic authentication using an email and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Organization Membership

ID: delete_organization_membership
Operation: write
Entities: user, ticket, organization membership
Summary: The Delete Organization Membership API immediately removes a user from an organization and schedules a job to unassign all working tickets currently assigned to the user and organization combination. The organization_id of the unassigned tickets is set to null. This operation is allowed for admins and agents when deleting an organization membership for an end user. The API requires the organization_membership_id as a path parameter and uses basic authentication for authorization. A successful request returns a 204 No Content status.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Organization Subscription

ID: delete_organization_subscription
Operation: write
Entities: agent, end user, organization subscription
Summary: The Delete Organization Subscription API allows agents and end users to delete an organization subscription by specifying the organization_subscription_id in the path parameters. The request requires basic authentication using an email address and API token. A successful request will result in a 204 No Content response, indicating that the organization subscription has been successfully deleted and no content is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Permanently Delete User

ID: delete_permanently_delete_user
Operation: write
Entities: user, organization, role
Summary: The Permanently Delete User API allows admins and agents with appropriate permissions to permanently delete a user from the system. Before using this API, the user must be deleted first. This action is irreversible and will remove all user information. The API requires the 'deleted_user_id' as a path parameter and uses basic authentication. The response includes details of the deleted user, and the API is subject to rate limits, allowing up to 700 deletions every 10 minutes.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Profile by Profile ID

ID: delete_profile_by_profile_id
Operation: write
Entities: agent, profile, role
Summary: The 'Delete Profile by Profile ID' API allows agents to delete a user profile specified by the profile ID. The endpoint is '/api/v2/user_profiles/{profile_id}' and uses the DELETE method. The request requires a path parameter 'profile_id' which is the Sunshine profile ID. The request must include an Authorization header with a basic authentication token. The response will be a 204 No Content status if successful, indicating the profile was deleted. If there is a client error, a 400 Bad Request status will be returned with an error object detailing the issue.
Input Fields: Input Fields
Output Fields: Output Fields

Remove App Installation

ID: delete_remove_app_installation
Operation: write
Entities: admin, app installation
Summary: The Remove App Installation API allows admins to remove an installed app by specifying the app installation ID in the path parameters. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a 204 No Content response, indicating that the app installation has been removed without returning any content.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Tags from Ticket

ID: delete_remove_tags_from_ticket
Operation: write
Entities: user, organization, ticket
Summary: The Remove Tags from Ticket API allows agents to delete specific tags from a ticket identified by its ticket_id. The request requires the ticket_id as a path parameter and a list of tags to be removed in the request body. The Content-Type header must be set to application/json. Upon successful deletion, the API returns a 204 No Content response, indicating that the tags have been successfully removed from the specified ticket.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Resource Collection

ID: delete_resource_collection
Operation: write
Entities: job status, resource collection
Summary: The 'Delete Resource Collection' API allows administrators to delete a specified resource collection by providing the resource_collection_id as a path parameter. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a job status object indicating the status of the deletion process, including a job ID, status, and a URL to check the job status.
Input Fields: Input Fields
Output Fields: Output Fields

Revoke OAuth Token

ID: delete_revoke_oauth_token
Operation: write
Entities: agent, OAuth token, admin
Summary: The Revoke OAuth Token API allows Admins, Agents, and End Users to revoke an OAuth token by its ID. The API requires the 'oauth_token_id' as a path parameter, which is mandatory. The request must include an 'Authorization' header for basic authentication using the user's email address and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the token has been successfully revoked and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Schedule

ID: delete_schedule
Operation: write
Entities: admin, schedule
Summary: The Delete Schedule API allows admins to delete a specific schedule by its ID. The request requires the schedule_id as a path parameter and must include the Content-Type header set to 'application/json' and an Authorization header with a basic authentication token. Upon successful deletion, the API returns a 204 No Content response, indicating that the schedule has been deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete SLA Policy

ID: delete_sla_policy
Operation: write
Entities: admin, account, SLA policy
Summary: The Delete SLA Policy API allows administrators to delete a specific SLA policy by providing the SLA policy ID in the path parameters. This API is available for accounts on the Support Professional or Suite Growth plan or above. The request requires a 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a 204 No Content response, indicating that the SLA policy has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Support Address

ID: delete_support_address
Operation: write
Entities: agent, admin, support address
Summary: The Delete Support Address API allows admins and agents with the necessary permissions to delete a support address by providing the support address ID in the path parameters. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the support address has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Suspended Ticket

ID: delete_suspended_ticket
Operation: write
Entities: agent, suspended ticket
Summary: The 'Delete Suspended Ticket' API allows unrestricted agents to delete a suspended ticket by its ID. The API requires the ID of the suspended ticket as a path parameter. The request must include an Authorization header for basic authentication using an email and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Target

ID: delete_target
Operation: write
Entities: target, admin, parameter
Summary: The Delete Target API allows admins to delete a specific target by its ID. The API requires the target_id as a path parameter, which is mandatory. The request must include the 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a 204 No Content response, indicating that the target has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket

ID: delete_ticket
Operation: write
Entities: agent, ticket, admin
Summary: The Delete Ticket API allows admins and agents with the appropriate permissions to delete a ticket identified by its ticket_id. The API endpoint is DELETE /api/v2/tickets/{ticket_id}. The request requires a path parameter 'ticket_id' which is the ID of the ticket to be deleted. Authentication is required via a Basic authentication token. The API returns a 204 No Content status upon successful deletion, indicating that the ticket has been deleted. The rate limit for this endpoint is 400 tickets per minute. For bulk deletion, consider using the Bulk Delete Tickets API.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket Field

ID: delete_ticket_field
Operation: write
Entities: ticket field, admin
Summary: The Delete Ticket Field API allows administrators to delete a specific ticket field by its ID. The API requires the ticket_field_id as a path parameter and optionally accepts a query parameter 'creator' to display additional properties if the ticket field was created by an app. The request must include an Authorization header with a basic authentication token. Upon successful deletion, the API returns a 204 No Content status with no response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket Field Option

ID: delete_ticket_field_option
Operation: write
Entities: ticket field, ticket field option
Summary: The Delete Ticket Field Option API allows admins to delete a specific ticket field option by providing the ticket field ID and the ticket field option ID as path parameters. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a 204 No Content response, indicating that the operation was successful and no content is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket Form

ID: delete_ticket_form
Operation: write
Entities: ticket form, admin
Summary: The Delete Ticket Form API allows administrators to delete a specific ticket form by its ID. The request requires the ticket_form_id as a path parameter and uses basic authentication with an email address and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the ticket form has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket Form Status By Id

ID: delete_ticket_form_status_by_id
Operation: write
Entities: ticket form, admin, ticket form status
Summary: The 'Delete Ticket Form Status By Id' API endpoint allows administrators to delete a specific ticket form status by its ID. The request requires the 'ticket_form_id' and 'ticket_form_status_id' as path parameters. The request must be authenticated using basic authentication with an email address and API token. Upon successful deletion, the API returns a 204 No Content response, indicating that the ticket form status has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket Form Statuses

ID: delete_ticket_form_statuses
Operation: write
Entities: agent, ticket form, status
Summary: The Delete Ticket Form Statuses API endpoint allows admins and agents to delete all statuses associated with a specific ticket form by its ID. The request requires the 'ticket_form_id' as a path parameter and a list of status IDs in the request body. The request must include 'Content-Type' and 'Authorization' headers. A successful request returns a 204 No Content response, indicating that the statuses have been successfully deleted.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket Permanently

ID: delete_ticket_permanently
Operation: write
Entities: rate limit, ticket, job status
Summary: The Delete Ticket Permanently API endpoint allows agents to permanently delete a soft-deleted ticket by enqueuing a ticket deletion job. The endpoint requires the ticket ID as a path parameter. Upon successful request, it returns a job_status JSON object indicating the job has been queued. The response includes rate limit information in the headers. The job status can be checked using the provided URL in the response body. This operation is irreversible and has its own rate limit separate from the account-wide limit.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket Trigger

ID: delete_ticket_trigger
Operation: write
Entities: agent, trigger
Summary: The Delete Ticket Trigger API allows agents to delete a specific ticket trigger by its ID. The API requires the 'trigger_id' as a path parameter, which is mandatory. The request should include the 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a 204 No Content status, indicating that the trigger has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Ticket Trigger Category

ID: delete_ticket_trigger_category
Operation: write
Entities: ticket trigger category, trigger
Summary: The Delete Ticket Trigger Category API allows you to delete a specific ticket trigger category by its ID. The request requires the 'trigger_category_id' as a path parameter and uses basic authentication with an email and API token. A successful deletion returns a 204 No Content status. If the category contains active ticket triggers, a 400 Bad Request is returned with an error message. If the category ID is not found, a 404 Not Found is returned with an appropriate error message.
Input Fields: Input Fields
Output Fields: Output Fields

Unassign Organization

ID: delete_unassign_organization
Operation: write
Entities: user, organization, ticket
Summary: The 'Unassign Organization' API endpoint allows agents to immediately remove a user from an organization. It schedules a job to unassign all working tickets currently assigned to the user and organization combination, setting the organization_id of the unassigned tickets to null. The API requires the 'organization_id' and 'user_id' as path parameters, and it uses basic authentication with an email address and API token. Upon successful execution, the API returns a 204 No Content response, indicating that the operation was successful and no content is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Upload

ID: delete_upload
Operation: write
Entities: attachment, upload
Summary: The Delete Upload API allows end users to delete an uploaded attachment using its token. The API requires a DELETE request to the endpoint /api/v2/uploads/{token}, where {token} is the path parameter representing the token of the uploaded attachment. The request must include an Authorization header for basic authentication using the user's email address and API token. Upon successful deletion, the API returns a 204 No Content response, indicating that the upload has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete User

ID: delete_user
Operation: write
Entities: agent, user, administrator
Summary: The Delete User API allows admins and agents with appropriate permissions to delete a user and associated records from the account in Zendesk Support. The user_id path parameter is required to specify which user to delete. The API uses basic authentication with an email address and API token. Upon successful deletion, the response includes the user's id, name, and active status set to false. Note that deleted users are not recoverable, and additional steps are required to comply with GDPR for permanent deletion.
Input Fields: Input Fields
Output Fields: Output Fields

Delete User Field

ID: delete_user_field
Operation: write
Entities: user field, admin
Summary: The Delete User Field API allows administrators to delete a specific user field by providing the user field ID or key in the path parameters. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the user field has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete User Field Option

ID: delete_user_field_option
Operation: write
Entities: option, user field, admin
Summary: The 'Delete User Field Option' API allows administrators to delete a specific user field option by providing the user field ID and the user field option ID in the path parameters. The request requires basic authentication using an email address and API token. Upon successful deletion, the API returns a 204 No Content status, indicating that the operation was successful and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete User Identity

ID: delete_user_identity
Operation: write
Entities: agent, identity, user
Summary: The Delete User Identity API allows agents to delete a specific identity associated with a user. The API requires the user ID and the user identity ID as path parameters. The request must be authenticated using a basic authentication token. Upon successful deletion, the API returns a 204 No Content status, indicating that the identity has been deleted. Note that in some cases, a phone number associated with the identity may still appear on the user profile, which can be removed by updating the user's phone attribute to an empty string.
Input Fields: Input Fields
Output Fields: Output Fields

Delete User Session

ID: delete_user_session
Operation: write
Entities: user, session
Summary: The Delete User Session API allows Admins, Agents, and End users to delete a specific session for a user. It requires the user_id and session_id as path parameters. The API uses basic authentication with an email address and API token. Upon successful deletion, it returns a 204 No Content response, indicating that the session has been successfully deleted and no content is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Delete View

ID: delete_view
Operation: write
Entities: agent, view
Summary: The Delete View API allows agents to delete a specific view by its ID. The request requires the view_id as a path parameter and must include the Content-Type header set to 'application/json'. Basic authentication is required using an email address and API token. A successful deletion returns a 204 No Content response, indicating that the view has been successfully deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Workspace

ID: delete_workspace
Operation: write
Entities: admin, workspace
Summary: The Delete Workspace API allows admins to delete a specific workspace by its ID. The request requires the workspace_id as a path parameter and uses basic authentication with an email address and API token. Upon successful deletion, the API returns a 204 No Content response, indicating that the workspace has been deleted and no content is returned in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

List Agent Attribute Values

ID: get_agent_attribute_values
Operation: read
Entities: agent, user, attribute
Summary: The 'List Agent Attribute Values' API endpoint allows agents and admins to retrieve attribute values for a specific agent identified by the user_id. The API requires a GET request to the endpoint '/api/v2/routing/agents/{user_id}/instance_values' with the user_id as a path parameter. The request must include an Authorization header for authentication. The response includes a list of attribute values, each with details such as creation and update timestamps, unique identifier, name, and URL.
Input Fields: Input Fields
Output Fields: Output Fields

List App Installation Requirements

ID: get_app_installation_requirements
Operation: read
Entities: agent, requirement, app installation
Summary: The 'List App Installation Requirements' API endpoint allows agents to retrieve a list of all requirements for a specific app installation. The request requires the 'app_installation_id' as a path parameter and an 'Authorization' header for authentication. The response includes a list of requirements, each with details such as 'account_id', 'created_at', 'identifier', 'requirement_id', 'requirement_type', and 'updated_at'.
Input Fields: Input Fields
Output Fields: Output Fields

Get App Public Key

ID: get_app_public_key
Operation: read
Entities: agent, app, public key
Summary: The 'Get App Public Key' API endpoint retrieves the public key of a specified app in PEM format. This key can be used to verify the legitimacy of certain requests from the app. The API requires the 'app_id' as a path parameter, which is mandatory. The response returns the public key as a string in PEM format. This endpoint is accessible to agents.
Input Fields: Input Fields
Output Fields: Output Fields

List Assignable Groups

ID: get_assignable_groups
Operation: read
Entities: agent, group, admin
Summary: The 'List Assignable Groups' API endpoint allows admins and agents to retrieve a list of groups that can be assigned. The API uses cursor or offset pagination, returning a maximum of 100 records per page. The request requires basic authentication using an email address and API token. The response includes details of each group such as creation date, ID, public status, name, and last update date.
Input Fields: Input Fields
Output Fields: Output Fields

List Attribute Values for an Attribute

ID: get_attribute_values_for_attribute
Operation: read
Entities: attribute, attribute value, admin
Summary: This API endpoint retrieves a list of attribute values for a specified skill-based routing attribute. It requires the 'attribute_id' as a path parameter, which is mandatory. The request must include an Authorization header with basic authentication using an email address and API token. The response includes a list of attribute values, each with details such as creation and update timestamps, ID, name, and URL.
Input Fields: Input Fields
Output Fields: Output Fields

Autocomplete Organizations

ID: get_autocomplete_organizations
Operation: read
Entities: agent, organization
Summary: The Autocomplete Organizations API allows agents to retrieve a list of organizations whose names start with a specified substring. The API uses offset pagination and is accessible to agents. It requires a 'name' query parameter, which is a substring of the organization name to search for. Optional query parameters include 'field_id', which is the ID of a lookup relationship field, and 'source', which specifies the type of the field if 'field_id' is provided. The response includes a count of organizations, pagination information, and details about each organization, such as creation date, domain names, and custom fields. Error responses include 400 for bad requests, 429 for too many requests, and 500 for internal server errors.
Input Fields: Input Fields
Output Fields: Output Fields

Autocomplete Users

ID: get_autocomplete_users
Operation: read
Entities: agent, user, name
Summary: The Autocomplete Users API allows agents to retrieve a list of users whose names start with a specified value. The API endpoint is '/api/v2/users/autocomplete?name={name}' and uses the GET method. It requires the 'name' query parameter to search for users. Optional query parameters include 'field_id' and 'source', which are used to specify lookup relationship fields. The response returns an array of user objects, each containing the user's ID, name, and optional notes.
Input Fields: Input Fields
Output Fields: Output Fields

List Available Public Locales

ID: get_available_public_locales
Operation: read
Entities: account, locale
Summary: The 'List Available Public Locales' API endpoint allows users to retrieve a list of translation locales that are available to all accounts. This is a GET request to the '/api/v2/locales/public' endpoint. The request requires basic authentication using an email address and API token. The response includes a list of locales, each with details such as creation date, unique identifier, locale code, name, last update date, and URL.
Input Fields: Input Fields
Output Fields: Output Fields

List Business Hours Schedules

ID: get_business_hours_schedules
Operation: read
Entities: time zone, interval, schedule
Summary: The List Business Hours Schedules API allows administrators to retrieve a list of business hours schedules from Zendesk. The API requires basic authentication using an email address and API token. The response includes an array of schedules, each with details such as creation and update timestamps, schedule ID, name, time zone, and time intervals.
Input Fields: Input Fields
Output Fields: Output Fields

Check Host Mapping Validity

ID: get_check_host_mapping_validity
Operation: read
Entities: host mapping, subdomain, brand
Summary: The 'Check Host Mapping Validity' API endpoint allows admins to verify if a given host mapping is valid for a specified subdomain. It requires two query parameters: 'host_mapping', which is the host mapping to a brand, and 'subdomain', which is the subdomain for a Zendesk account address. The API returns a JSON object containing a 'cname' field, which is the canonical name record for the host mapping, and an 'is_valid' field, which indicates whether the host mapping is valid.
Input Fields: Input Fields
Output Fields: Output Fields

Check Host Mapping Validity for an Existing Brand

ID: get_check_host_mapping_validity_for_an_existing_brand
Operation: read
Entities: host mapping, admin, brand
Summary: The 'Check Host Mapping Validity for an Existing Brand' API endpoint allows administrators to verify if a host mapping is valid for a specified brand. The request requires the 'brand_id' as a path parameter, which is mandatory. The response returns a JSON object containing the 'cname' and a boolean 'is_valid' indicating the validity of the host mapping.
Input Fields: Input Fields
Output Fields: Output Fields

Getting Comments

ID: get_comments
Operation: read
Entities: comment, request
Summary: The 'Getting Comments' API endpoint allows end users to retrieve a specific comment from a request by providing the request ID and the ticket comment ID as path parameters. The API requires basic authentication using an email address and API token. The response includes the comment's content and its ID.
Input Fields: Input Fields
Output Fields: Output Fields

Show Compliance Deletion Statuses

ID: get_compliance_deletion_statuses
Operation: read
Entities: user, compliance deletion status, application
Summary: The 'Show Compliance Deletion Statuses' API endpoint retrieves the GDPR compliance deletion status for a specified user across different areas of compliance within Zendesk. The endpoint requires the 'user_id' as a path parameter and optionally accepts 'application' as a query parameter to filter the compliance area. The response includes a list of compliance deletion statuses, detailing actions taken, the application area, timestamps, and executer information. If the user is not found, a 404 error is returned.
Input Fields: Input Fields
Output Fields: Output Fields

Count Activities

ID: get_count_activities
Operation: read
Entities: agent, activity
Summary: The Count Activities API endpoint returns an approximate count of ticket activities in the last 30 days affecting the agent making the request. If the count exceeds 100,000, a cached result is returned, which updates every 24 hours. The response includes a 'count' object with 'refreshed_at', a timestamp indicating when the count was last updated, and 'value', the count of activities. Note that 'refreshed_at' may be null if the count is being updated in the background, and 'value' is limited to 100,000 until the update is complete. This API is accessible to agents and requires basic authentication.
Input Fields: Input Fields
Output Fields: Output Fields

Count Audits for a Ticket

ID: get_count_audits_for_a_ticket
Operation: read
Entities: agent, ticket, audit
Summary: The 'Count Audits for a Ticket' API endpoint returns an approximate count of audits for a specified ticket. It requires the ticket ID as a path parameter and uses basic authentication with an email address and API token. The response includes a count object with a 'refreshed_at' timestamp indicating when the count was last updated and a 'value' representing the number of audits. If the count exceeds 100,000, a cached result is returned, which updates every 24 hours. The 'refreshed_at' may be null if the count is being updated in the background.
Input Fields: Input Fields
Output Fields: Output Fields

Count Deleted Users

ID: get_count_deleted_users
Operation: read
Entities: agent, user
Summary: The 'Count Deleted Users' API endpoint provides an approximate count of deleted users, including those permanently deleted. It is accessible via a GET request to '/api/v2/deleted_users/count'. The response includes a 'count' object with a 'value' indicating the number of deleted users and a 'refreshed_at' timestamp showing when the count was last updated. If the count exceeds 100,000, it is updated every 24 hours, and 'refreshed_at' may be null during updates. This API requires basic authentication with an email address and API token.
Input Fields: Input Fields
Output Fields: Output Fields

Count Groups

ID: get_count_groups
Operation: read
Entities: user, group
Summary: The Count Groups API returns an approximate count of groups. It supports two endpoints: '/api/v2/groups/count' and '/api/v2/users/{user_id}/groups/count'. The count is updated every 24 hours if it exceeds 100,000. The 'refreshed_at' property indicates when the count was last updated. If the count exceeds 100,000, 'refreshed_at' may be null, indicating an ongoing update. The API requires basic authentication and is accessible to Admins and Agents. The 'user_id' path parameter is required for the user-specific endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

Count Organizations

ID: get_count_organizations
Operation: read
Entities: agent, organization, user
Summary: The Count Organizations API provides an approximate count of organizations. It supports two endpoints: '/api/v2/organizations/count' and '/api/v2/users/{user_id}/organizations/count.json'. The count is updated every 24 hours if it exceeds 100,000. The 'refreshed_at' property indicates the last update timestamp, and may be null if the count is being updated in the background. The API requires basic authentication using an email address and API token.
Input Fields: Input Fields
Output Fields: Output Fields

Count Satisfaction Ratings

ID: get_count_satisfaction_ratings
Operation: read
Entities: satisfaction rating, admin, account
Summary: The 'Count Satisfaction Ratings' API endpoint provides an approximate count of satisfaction ratings in the account. It is accessible via a GET request to '/api/v2/satisfaction_ratings/count'. The response includes a 'count' object with 'refreshed_at', a timestamp indicating when the count was last updated, and 'value', the count of satisfaction ratings. If the count exceeds 100,000, the result may be cached and updated every 24 hours. The API requires basic authentication with an email address and API token. This endpoint is allowed for admins.
Input Fields: Input Fields
Output Fields: Output Fields

Count Tags

ID: get_count_tags
Operation: read
Entities: count, tag
Summary: The Count Tags API endpoint provides an approximate count of tags in the Zendesk system. It is accessible via a GET request to the /api/v2/tags/count endpoint. The response includes a count object with a 'value' property indicating the number of tags and a 'refreshed_at' timestamp showing when the count was last updated. If the count exceeds 100,000, it is updated every 24 hours, and the 'refreshed_at' property may be null during updates. This API requires basic authentication using an email address and API token.
Input Fields: Input Fields
Output Fields: Output Fields

Count Ticket Comments

ID: get_count_ticket_comments
Operation: read
Entities: agent, ticket, comment
Summary: The 'Count Ticket Comments' API endpoint returns an approximate count of comments added to a specified ticket. It requires the 'ticket_id' as a path parameter and uses basic authentication via headers. The response includes a 'count' object with 'value', representing the number of comments, and 'refreshed_at', a timestamp of the last update. If the count exceeds 100,000, the result may be cached and updated every 24 hours, with 'refreshed_at' potentially being null during updates.
Input Fields: Input Fields
Output Fields: Output Fields

Count Ticket Fields

ID: get_count_ticket_fields
Operation: read
Entities: agent, ticket field, account
Summary: The 'Count Ticket Fields' API endpoint provides an approximate count of both system and custom ticket fields within an account. It is accessible via a GET request to '/api/v2/ticket_fields/count'. The response includes a 'count' object with 'refreshed_at', a timestamp indicating the last update time, and 'value', the count of ticket fields. If the count exceeds 100,000, the result may be cached and updated every 24 hours. During updates, 'refreshed_at' may be null, and 'value' is capped at 100,000. This API is intended for use by agents and requires basic authentication using an email address and API token.
Input Fields: Input Fields
Output Fields: Output Fields

Count Tickets

ID: get_count_tickets
Operation: read
Entities: user, organization, ticket
Summary: The Count Tickets API returns an approximate count of tickets in the account. It supports multiple endpoints to count tickets for the entire account, a specific organization, or a specific user. The count is updated every 24 hours if it exceeds 100,000. The response includes a 'refreshed_at' timestamp indicating the last update time and a 'value' representing the ticket count. The API requires basic authentication using an email address and API token.
Input Fields: Input Fields
Output Fields: Output Fields

Count Tickets in View

ID: get_count_tickets_in_view
Operation: read
Entities: agent, ticket, view
Summary: The 'Count Tickets in View' API endpoint allows users to retrieve the ticket count for a specific view without fetching the entire view. This is useful for estimating the size of a view. The endpoint is rate limited to 5 requests per minute per view per agent. The response includes the view ID, the API URL of the count, the cached number of tickets, a pretty-printed approximation of the count, and a freshness indicator. The count may be cached for 60-90 minutes for views with a large number of tickets, and may not reflect the actual number of tickets at all times. The request requires a path parameter 'view_id' and an authorization header.
Input Fields: Input Fields
Output Fields: Output Fields

Count Tickets in Views

ID: get_count_tickets_in_views
Operation: read
Entities: agent, ticket, view
Summary: The 'Count Tickets in Views' API endpoint allows agents to retrieve the ticket count for multiple views by providing a list of view IDs. The endpoint accepts up to 20 view IDs per request, specified as a comma-separated string in the 'ids' query parameter. The response includes an array of view counts, each containing details such as whether the count is fresh, a human-readable representation of the count, the URL to the view count, the actual count value, and the view ID. This endpoint is rate-limited to 6 requests every 5 minutes and only returns counts for views accessible to the requesting user.
Input Fields: Input Fields
Output Fields: Output Fields

Count Users

ID: get_count_users
Operation: read
Entities: user, organization, group
Summary: The Count Users API provides an approximate count of users in the system. It supports filtering by permission set and role, allowing for custom role filtering on the Enterprise plan and above. The API returns a count object with a refreshed_at timestamp indicating the last update time and a value representing the user count. If the count exceeds 100,000, it is updated every 24 hours, and the refreshed_at property may be null during updates. The API is accessible to Admins, Agents, and Light Agents.
Input Fields: Input Fields
Output Fields: Output Fields

Count Views

ID: get_count_views
Operation: read
Entities: user, view
Summary: The Count Views API endpoint returns an approximate count of shared and personal views available to the current user. It is accessible via a GET request to /api/v2/views/count. The response includes a 'count' object with 'refreshed_at', a timestamp indicating when the count was last updated, and 'value', the count of views. If the count exceeds 100,000, a cached result is returned, updated every 24 hours. The API requires basic authentication using an email address and API token.
Input Fields: Input Fields
Output Fields: Output Fields

Show the Currently Authenticated Session

ID: get_currently_authenticated_session
Operation: read
Entities: user, session
Summary: This API endpoint retrieves the currently authenticated session for the user making the request. It is accessible to Admins, Agents, and End users. The request requires basic authentication using an email address and API token. The response includes details about the session such as the authentication time, session ID, last seen time, session URL, and user ID.
Input Fields: Input Fields
Output Fields: Output Fields

Show Custom Ticket Status

ID: get_custom_ticket_status
Operation: read
Entities: custom status, ticket, end user
Summary: The 'Show Custom Ticket Status' API endpoint retrieves the details of a specific custom ticket status by its ID. It is accessible to end users. The request requires the 'custom_status_id' as a path parameter, which is mandatory. The response includes detailed information about the custom status, such as its activity status, labels for agents and end users, descriptions, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List Custom Ticket Statuses

ID: get_custom_ticket_statuses
Operation: read
Entities: status category, account, custom ticket status
Summary: The 'List Custom Ticket Statuses' API endpoint retrieves all undeleted custom ticket statuses for the account. It supports filtering by active status, default status, and status categories through query parameters. The response includes details such as the status's active state, labels, descriptions, and timestamps. This API is accessible to end users and does not provide pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Get Deletion Schedule

ID: get_deletion_schedule
Operation: read
Entities: deletion schedule
Summary: The Get Deletion Schedule API retrieves a deletion schedule by its ID. It is accessible to admins and requires the deletion_schedule_id as a path parameter. The API uses basic authentication with an email address and API token. The response includes details about the deletion schedule, such as its active status, conditions, creation and update timestamps, description, and URL.
Input Fields: Input Fields
Output Fields: Output Fields

List Deletion Schedules

ID: get_deletion_schedules
Operation: read
Entities: data, deletion schedule, account
Summary: The 'List Deletion Schedules' API endpoint allows administrators to retrieve all deletion schedules for a Zendesk account. Deletion schedules are configurations that automatically delete data after a specified period. The API requires basic authentication using an email address and API token. The response includes details of each deletion schedule, such as its active status, conditions, creation and update timestamps, description, and URL.
Input Fields: Input Fields
Output Fields: Output Fields

Detect Best Language for User

ID: get_detect_best_language_for_user
Operation: read
Entities: user, locale
Summary: The 'Detect Best Language for User' API endpoint allows users to determine the best matching language locale from a list of available locales. It is accessible to anyone and requires a GET request to the specified URL. The request must include a JSON body with an 'available_locales' array, listing the locales to choose from. The response returns a JSON object containing details of the best-matched locale, including its creation and update timestamps, ID, locale code, name, and URL.
Input Fields: Input Fields
Output Fields: Output Fields

List Dynamic Content Items

ID: get_dynamic_content_items
Operation: read
Entities: agent, admin, dynamic content item
Summary: The List Dynamic Content Items API endpoint allows admins and agents with the appropriate permissions to retrieve a list of all dynamic content items associated with their account. The API uses cursor or offset pagination to manage large sets of data. The response includes details about each dynamic content item, such as its creation date, default locale ID, name, and associated variants. Each variant includes information such as its content, locale ID, and whether it is active or outdated.
Input Fields: Input Fields
Output Fields: Output Fields

Get Events by Sunshine Profile

ID: get_events_by_sunshine_profile
Operation: read
Entities: profile, event, parameter
Summary: The 'Get Events by Sunshine Profile' API endpoint allows agents to retrieve events associated with a specific Sunshine profile by specifying an identifier in the query parameters. The identifier is mandatory and should be in the format source:type:identifier_type:identifier_value. Optional query parameters include filters for event source, type, start and end times, and the number of events per page. The response includes a list of events with details such as creation time, description, properties, source, and type, along with pagination links and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

Get Events by Sunshine Profile ID

ID: get_events_by_sunshine_profile_id
Operation: read
Entities: agent, user profile, event
Summary: The 'Get Events by Sunshine Profile ID' API endpoint retrieves events associated with a specific Sunshine profile. It requires the 'profile_id' as a path parameter. Optional query parameters include 'filter[end_time]', 'filter[source]', 'filter[start_time]', 'filter[type]', and 'page[size]' to filter and paginate the events. The response includes a list of events with details such as creation time, description, properties, source, and type. It also provides pagination links and metadata indicating if more results are available.
Input Fields: Input Fields
Output Fields: Output Fields

Execute View

ID: get_execute_view
Operation: read
Entities: agent, ticket, view
Summary: The Execute View API endpoint allows agents to retrieve the column titles and rows of a specified view in Zendesk. The endpoint requires the view_id as a path parameter and supports optional query parameters for sorting the results by a specified ticket field and order. The response includes the columns and rows of the view, with each row containing a partial ticket object. The API is rate-limited to 5 requests per minute per view per agent and is designed for periodic use. For more frequent updates, Zendesk recommends using the Incremental Ticket Export endpoint.
Input Fields: Input Fields
Output Fields: Output Fields

Export Search Results

ID: get_export_search_results
Operation: read
Entities: user, organization, ticket
Summary: The Export Search Results API allows agents to export a set of search results from the Zendesk system. This endpoint is particularly useful for search queries that return more than 1000 results. The results are ordered by the created_at attribute and can only return results of a single object type, which must be specified using the filter[type] parameter. Supported object types include ticket, organization, user, or group. The API supports cursor pagination, allowing a maximum of 1000 records per page, with the page size determined by the page[size] parameter. The response includes links for pagination, meta information about the cursor and whether more results are available, and the results themselves. The API is rate-limited to 100 requests per minute per account.
Input Fields: Input Fields
Output Fields: Output Fields

Export View as CSV

ID: get_export_view_as_csv
Operation: read
Entities: csv attachment, view, job
Summary: The 'Export View as CSV' API allows agents to export a specified view as a CSV file. The API endpoint is '/api/v2/views/{view_id}/export' and uses the GET method. The request requires a path parameter 'view_id' which is the ID of the view to be exported. The request must include an 'Authorization' header for basic authentication using an email address and API token. The response returns a JSON object indicating the status of the export job and the view ID. If the export is possible, it returns a CSV attachment; otherwise, it enqueues a job to produce the CSV.
Input Fields: Input Fields
Output Fields: Output Fields

Filter Definitions

ID: get_filter_definitions
Operation: read
Entities: definition, filter, relationship
Summary: The Filter Definitions API endpoint allows you to retrieve filter definitions based on a specified target type. The target type can be users, tickets, organizations, or custom objects. You can optionally specify a source type to filter the definitions further. The API requires a path parameter 'target_type' and optionally accepts a query parameter 'source_type'. The response includes a list of filter definitions that can be used to build custom fields or ticket fields' relationship filters.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental Attributes Export

ID: get_incremental_attributes_export
Operation: read
Entities: attribute, cursor, admin
Summary: The Incremental Attributes Export API allows admins to retrieve a stream of changes that occurred on routing attributes. It uses a GET method on the endpoint /api/v2/incremental/routing/attributes. The API accepts an optional query parameter 'cursor' to navigate through the changes over time. The response includes a list of attributes with details such as id, name, time of change, and type of change. It also provides pagination support with 'next_page' URL for fetching subsequent changes.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental Attributes Values Export

ID: get_incremental_attributes_values_export
Operation: read
Entities: cursor, admin, routing attribute
Summary: The Incremental Attributes Values Export API allows administrators to retrieve a stream of changes that occurred on routing attribute values. It uses a GET method to access the endpoint '/api/v2/incremental/routing/attribute_values'. The API requires basic authentication using an email address and API token. It accepts an optional query parameter 'cursor' to navigate through the changes over time. The response includes a list of attribute values with details such as attribute ID, value ID, name, time of change, and type of change. Additionally, it provides the count of attribute values, the end time of the changes, and a URL for the next page of results.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental Instance Values Export

ID: get_incremental_instance_values_export
Operation: read
Entities: attribute value, event, routing instance
Summary: The Incremental Instance Values Export API allows administrators to retrieve a stream of changes that occurred on routing instance values. The changes are grouped by attribute_value_id and include both associate and unassociate type events, ordered by the unassociate event's timestamp. The API supports pagination through the use of a cursor parameter, which is a non-human-readable argument used to navigate through the data stream. The response includes the count of instance values, the end time of the data stream, a list of instance value changes, and a URL for the next page of results if available.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental Organization Export

ID: get_incremental_organization_export
Operation: read
Entities: export, organization, parameter
Summary: The Incremental Organization Export API allows administrators to export organization data incrementally from a specified start time. The API requires a start_time query parameter, which must be at least one minute in the past, and optionally accepts a per_page parameter to specify the number of records per page. The response includes details about the organizations, such as creation time, domain names, external ID, group ID, and custom fields. The API is accessible to admins and supports sideloading. The response also indicates if the end of the stream has been reached and provides a URL for the next page of results.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental Sample Export

ID: get_incremental_sample_export
Operation: read
Entities: user, organization, ticket
Summary: The Incremental Sample Export API allows users to test the incremental export format with stricter rate limits and a maximum of 50 results per request. The API requires the 'incremental_resource' path parameter to specify the resource type, which can be 'tickets', 'ticket_events', 'users', or 'organizations'. The 'start_time' query parameter is mandatory and specifies the time to start the incremental export from, which must be at least one minute in the past. The response includes an array of results for the requested resource and a boolean indicating if the end of the stream has been reached.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental Side Conversation Event Export

ID: get_incremental_side_conversation_event_export
Operation: read
Entities: side conversation, ticket, event
Summary: The Incremental Side Conversation Event Export API allows administrators to retrieve side conversation events created since a specified start time. The API requires a 'unix_time' query parameter, which is an integer representing the start time for incremental exports. The response includes the count of events, the end time, and a list of events with details such as the actor, creation time, message content, and side conversation ID. The response also provides a URL for the next page of results if available.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental Ticket Event Export

ID: get_incremental_ticket_event_export
Operation: read
Entities: comment, ticket event, attachment
Summary: The Incremental Ticket Event Export API allows administrators to retrieve a stream of changes that occurred on tickets, excluding events occurring within one minute of the request. The API requires a 'start_time' query parameter, which specifies the time to start the incremental export from. The response includes details about ticket events, such as the event ID, instance ID, metric, ticket ID, time, and type. The API supports sideloading of comment events, which can be included in the event's child_events array. The response also provides pagination details, including the next page URL.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental Ticket Export, Cursor Based

ID: get_incremental_ticket_export_cursor_based
Operation: read
Entities: ticket, admin
Summary: The Incremental Ticket Export, Cursor Based API allows administrators to export tickets that have changed since a specified start time using a cursor-based approach. This method provides consistent performance and manageable response sizes. The API requires a start_time query parameter, which must be at least one minute in the past, and optionally accepts a cursor parameter for subsequent requests. The response includes a list of updated tickets, an end_of_stream indicator, and an after_cursor for pagination.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental Ticket Export, Time Based

ID: get_incremental_ticket_export_time_based
Operation: read
Entities: export, ticket, system
Summary: The Incremental Ticket Export, Time Based API allows administrators to retrieve tickets that have changed since a specified start time. The API uses time-based incremental exports and requires a start_time query parameter, which must be at least one minute in the past. The endpoint returns tickets with a generated_timestamp value that may be earlier than the start_time due to system updates. The API requires Basic authentication and returns a list of tickets in JSON format, including their IDs, updated_at times, and generated timestamps.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental User Export, Cursor Based

ID: get_incremental_user_export_cursor_based
Operation: read
Entities: user, export, admin
Summary: The Incremental User Export, Cursor Based API allows administrators to export user data incrementally using a cursor-based pagination system. The API requires a start_time parameter to specify the beginning of the export period, which must be at least one minute in the past. Optional parameters include cursor for subsequent requests and per_page to define the number of records per page. The response includes a list of user objects, a next_page URL for pagination, and an end_of_stream flag indicating if there are more records to fetch.
Input Fields: Input Fields
Output Fields: Output Fields

Incremental User Export, Time Based

ID: get_incremental_user_export_time_based
Operation: read
Entities: user, export, admin
Summary: The Incremental User Export, Time Based API allows administrators to export user data incrementally starting from a specified time. The API requires a 'start_time' query parameter, which must be at least one minute in the past, and optionally accepts a 'per_page' parameter to specify the number of records per page. The response includes a list of users, a 'next_page' URL for pagination, and an 'end_time' indicating the end of the current export. This API is accessible to admins and supports sideloading.
Input Fields: Input Fields
Output Fields: Output Fields

Get Information About App

ID: get_information_about_app
Operation: read
Entities: app
Summary: The 'Get Information About App' API retrieves detailed information about a specified app that is accessible to the current user and account. The API requires the 'app_id' as a path parameter to identify the app. The response includes comprehensive details about the app such as the author's information, creation date, framework version, installation instructions, and more. The API is accessible to everyone and returns a JSON object containing all the relevant app details.
Input Fields: Input Fields
Output Fields: Output Fields

Show Job Status

ID: get_job_status
Operation: read
Entities: agent, job status
Summary: The 'Show Job Status' API endpoint allows agents to retrieve the status of a background job by providing the job_status_id as a path parameter. The API returns detailed information about the job status, including its unique ID, message, progress, results of actions performed, current status, total number of actions, and a URL to access the job status. This information helps agents track the progress and outcome of background jobs.
Input Fields: Input Fields
Output Fields: Output Fields

List Access Logs

ID: get_list_access_logs
Operation: read
Entities: user, parameter, access log
Summary: The List Access Logs API endpoint allows administrators to retrieve a list of access logs based on various query parameters. The API supports cursor pagination and is rate-limited to 50 requests per minute. It does not include standard rate limit headers but returns a 'ratelimit-reset' header when the limit is reached. Query parameters include filters for timestamps, user ID, URL path, and pagination cursors. The response includes access log details such as authorization type, client information, HTTP method, status, timestamp, and user ID. Pagination links and metadata are also provided in the response.
Input Fields: Input Fields
Output Fields: Output Fields

List Account Attributes

ID: get_list_account_attributes
Operation: read
Entities: attribute, attribute value, account
Summary: The 'List Account Attributes' API endpoint retrieves a list of attributes associated with the account. It supports sideloading of attribute values available on the account. This API is accessible to agents and admins. The request requires basic authentication using an email address and API token. The response includes an array of attributes, each with details such as creation and update timestamps, unique identifier, and name. The response also provides pagination information with 'next_page' and 'previous_page' URLs.
Input Fields: Input Fields
Output Fields: Output Fields

List Active Automations

ID: get_list_active_automations
Operation: read
Entities: agent, permission, automation
Summary: The 'List Active Automations' API endpoint allows agents to retrieve a list of all active automations. The request can include optional query parameters such as 'sort_by' and 'sort_order' to filter and sort the results. The response includes a list of automations with details such as their ID, title, creation and update dates, and usage statistics over various time periods. The API requires basic authentication using an email address and API token.
Input Fields: Input Fields
Output Fields: Output Fields

List Active Macros

ID: get_list_active_macros
Operation: read
Entities: agent, macro, category
Summary: The 'List Active Macros' API endpoint allows agents to retrieve a list of all active shared and personal macros available to the current user. It supports various query parameters to filter and sort the macros, such as 'access', 'category', 'group_id', 'include', 'sort_by', and 'sort_order'. The response includes the count of macros and details of each macro, such as actions, active status, description, ID, position, restrictions, and title. The API also supports sideloads for additional data, such as app installations, categories, permissions, and usage statistics over different time periods.
Input Fields: Input Fields
Output Fields: Output Fields

List Active Ticket Triggers

ID: get_list_active_ticket_triggers
Operation: read
Entities: agent, trigger, app installation
Summary: The 'List Active Ticket Triggers' API endpoint allows agents to retrieve a list of all active ticket triggers in the system. The API supports both cursor and offset pagination, returning a maximum of 100 records per page. Optional query parameters include 'category_id' to filter triggers by category, 'sort' for cursor-based pagination, 'sort_by' for offset pagination, and 'sort_order' to specify the order of results. The response includes details about each trigger, such as its actions, conditions, creation and update timestamps, and URLs. Sideloads are supported to include additional information like app installations, permissions, and usage statistics over various time frames.
Input Fields: Input Fields
Output Fields: Output Fields

List Active Views

ID: get_list_active_views
Operation: read
Entities: agent, permission, view
Summary: The 'List Active Views' API endpoint allows agents to retrieve a list of active shared and personal views available to the current user. The API supports offset pagination, returning a maximum of 100 records per page. It accepts optional query parameters such as 'access' to filter views by access type, 'group_id' to filter by group, 'sort_by' to specify sorting criteria, and 'sort_order' to define the sorting order. The response includes the count of views, pagination links, and details of each view such as its ID, title, description, and position.
Input Fields: Input Fields
Output Fields: Output Fields

List Activities

ID: get_list_activities
Operation: read
Entities: agent, user, activity
Summary: The List Activities API endpoint allows agents to retrieve a list of ticket activities that have occurred in the last 30 days and have affected the agent making the request. The API supports cursor and offset pagination, returning a maximum of 100 records per page. The response includes arrays of user records for all actors and users involved in the listed activities. The API accepts an optional query parameter 'since' to filter activities from a specific UTC time in ISO 8601 format. The response includes detailed information about each activity, including the actor, user, and ticket details.
Input Fields: Input Fields
Output Fields: Output Fields

List All Apps

ID: get_list_all_apps
Operation: read
Entities: agent, app, admin
Summary: The 'List All Apps' API endpoint retrieves a list of all public apps available on the Zendesk Marketplace. For authenticated agents and admins, it also includes their account's private apps. The request requires basic authentication using an email address and API token. The response includes detailed information about each app, such as the organization details, author information, categories, creation and publication dates, installation details, and more. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

List All Ticket Audits

ID: get_list_all_ticket_audits
Operation: read
Entities: ticket audit, record, archived ticket
Summary: The 'List All Ticket Audits' API endpoint retrieves ticket audits, excluding archived tickets. It is accessible to admins and supports cursor pagination, returning up to 100 records per page. The API accepts an optional 'limit' query parameter to specify the maximum number of results returned. The response includes an array of ticket audits, each with details such as the audit ID, ticket ID, creation date, and events. The response also provides pagination links for navigating through the results.
Input Fields: Input Fields
Output Fields: Output Fields

List App Installations

ID: get_list_app_installations
Operation: read
Entities: agent, app, app installation
Summary: The List App Installations API endpoint allows users to retrieve a list of all app installations in their Zendesk account. The API uses a GET request to the /api/v2/apps/installations endpoint. Users must provide their subdomain and authenticate using a basic authentication token. The API supports an optional query parameter 'include' to side-load the app object associated with each installation. The response includes details about each installation, such as app ID, creation date, enabled status, and various settings. The 'enabled' property indicates whether the installed app is active in the product.
Input Fields: Input Fields
Output Fields: Output Fields

List Assignable Group Memberships

ID: get_list_assignable_group_memberships
Operation: read
Entities: agent, group membership, group
Summary: The 'List Assignable Group Memberships' API endpoint allows agents to retrieve a list of assignable group memberships. It supports cursor and offset pagination, returning a maximum of 100 records per page. The request requires basic authentication using an email and API token. Optionally, a group ID can be specified to filter memberships for a specific group. The response includes details such as creation and update timestamps, group ID, membership ID, user ID, and whether the membership is default.
Input Fields: Input Fields
Output Fields: Output Fields

List Audit Logs

ID: get_list_audit_logs
Operation: read
Entities: source, audit log, actor
Summary: The List Audit Logs API allows administrators with audit log access to retrieve a list of audit logs. The API supports cursor and offset pagination, returning a maximum of 100 records per page. It provides various query parameters to filter the logs by action, actor ID, creation time, IP address, source ID, and source type. The response includes details such as the action performed, actor information, change description, creation timestamp, and source details.
Input Fields: Input Fields
Output Fields: Output Fields

List Audits for a Ticket

ID: get_list_audits_for_a_ticket
Operation: read
Entities: agent, ticket, audit
Summary: The 'List Audits for a Ticket' API endpoint allows agents to retrieve a list of audits for a specified ticket. The endpoint uses the GET method and requires the 'ticket_id' as a path parameter. The request must include an Authorization header for authentication. The response includes a list of audit records, each containing details such as the audit ID, ticket ID, creation time, author ID, and additional metadata. The API supports cursor and offset pagination, returning a maximum of 100 records per page, except for archived tickets which do not support pagination.
Input Fields: Input Fields
Output Fields: Output Fields

List Automations

ID: get_list_automations
Operation: read
Entities: agent, permission, automation
Summary: The 'List Automations' API endpoint allows agents to retrieve a list of all automations for the current account. It supports optional query parameters such as 'active' to filter by active or inactive automations, 'sort_by' to specify the sorting criteria, and 'sort_order' to determine the order of sorting. The API uses cursor or offset pagination and returns a maximum of 100 records per page. The response includes details about each automation, such as its ID, title, active status, and timestamps for creation and last update.
Input Fields: Input Fields
Output Fields: Output Fields

List Bookmarks

ID: get_list_bookmarks
Operation: read
Entities: agent, ticket, bookmark
Summary: The List Bookmarks API allows agents to retrieve a list of bookmarks from the Zendesk account. The request requires basic authentication using an email address and API token. The API endpoint is '/api/v2/bookmarks' and it returns a list of bookmarks with details such as creation date, bookmark ID, associated ticket details, and URLs. The response includes pagination information with 'next_page' and 'previous_page' fields.
Input Fields: Input Fields
Output Fields: Output Fields

List Brands

ID: get_list_brands
Operation: read
Entities: agent, admin, brand
Summary: The List Brands API endpoint allows users to retrieve a list of all brands associated with their account, sorted by name. This API is accessible to admins and agents with the 'assign_tickets_to_any_brand' permission, who can list all brands. Agents without this permission can only list brands they are members of. The API supports both cursor and offset pagination. The response includes detailed information about each brand, such as its active status, URLs, creation and update timestamps, logo details, and associated ticket form IDs.
Input Fields: Input Fields
Output Fields: Output Fields

List Collaborators for a Ticket

ID: get_list_collaborators_for_a_ticket
Operation: read
Entities: agent, ticket, collaborator
Summary: This API endpoint retrieves a list of collaborators for a specific ticket. It requires the ticket ID as a path parameter and uses basic authentication with an email address and API token. The response includes a list of users who are collaborators on the ticket, each with an ID and name.
Input Fields: Input Fields
Output Fields: Output Fields

List Comments for a Ticket

ID: get_list_comments_for_a_ticket
Operation: read
Entities: comment, ticket, pagination
Summary: The List Comments API retrieves comments added to a specific ticket identified by the ticket_id. It supports cursor and offset pagination, allowing a maximum of 100 records per page. Comments can be sorted by creation date in ascending or descending order. Optional query parameters include 'include' to list email CCs by side-loading users, and 'include_inline_images' to list inline images as attachments. The response includes details of each comment, such as attachments, author information, creation date, and metadata.
Input Fields: Input Fields
Output Fields: Output Fields

List Custom Roles

ID: get_list_custom_roles
Operation: read
Entities: agent, ticket, custom role
Summary: The 'List Custom Roles' API endpoint allows agents on the Enterprise plan or above to retrieve a list of custom roles available in their Zendesk account. The API requires basic authentication using an email address and API token. The response includes detailed information about each custom role, such as configuration settings, creation and update timestamps, descriptions, role IDs, names, role types, and team member counts. This API is useful for managing and understanding the roles and permissions within a Zendesk account.
Input Fields: Input Fields
Output Fields: Output Fields

List Deleted Tickets

ID: get_list_deleted_tickets
Operation: read
Entities: agent, ticket
Summary: The 'List Deleted Tickets' API endpoint retrieves a list of deleted tickets that have not yet been archived or scrubbed in the past 30 days. It returns a maximum of 100 deleted tickets per page, ordered chronologically by their creation date. The API supports cursor and offset pagination and allows sorting by 'id', 'subject', or 'deleted_at' in either ascending or descending order. The response includes rate limit information in the headers, detailing the total, remaining, and reset time for requests. The API is accessible to agents and has a rate limit of 10 requests per minute, with a reduced limit of 5 requests per minute for pages beyond 100.
Input Fields: Input Fields
Output Fields: Output Fields

List Deleted Users

ID: get_list_deleted_users
Operation: read
Entities: agent, organization, user
Summary: The 'List Deleted Users' API endpoint allows agents to retrieve a list of deleted users, including those permanently deleted. The API uses cursor and offset pagination, returning a maximum of 100 records per page. Permanently deleted users will have null values for personal data fields such as email and phone, and their name will be 'Permanently Deleted User'. The request requires basic authentication and the subdomain of the Zendesk account. The response includes details of each deleted user, such as their ID, name, email, role, and organization ID.
Input Fields: Input Fields
Output Fields: Output Fields

List Email CCs for a Ticket

ID: get_list_email_ccs_for_a_ticket
Operation: read
Entities: user, ticket, email cc
Summary: This API endpoint retrieves the list of users who are CC'd on a specific ticket in Zendesk Support. The endpoint requires the ticket ID as a path parameter. The CCs and Followers feature must be enabled in Zendesk Support for this endpoint to function as expected. If the feature is not enabled, the default CC functionality is used, and the List Collaborators endpoint should be used instead. The response includes a list of users with their IDs and names who are CC'd on the ticket.
Input Fields: Input Fields
Output Fields: Output Fields

List Followers for a Ticket

ID: get_list_followers_for_a_ticket
Operation: read
Entities: agent, ticket, user
Summary: The 'List Followers for a Ticket' API endpoint allows agents to retrieve a list of users who follow a specific ticket in Zendesk Support. The API requires the CCs and Followers feature to be enabled. The request must include the ticket ID as a path parameter and requires basic authentication using an email address and API token. The response returns a list of users, each with an ID and name, who are following the specified ticket.
Input Fields: Input Fields
Output Fields: Output Fields

List Global OAuth Clients

ID: get_list_global_oauth_clients
Operation: read
Entities: user, account, oauth client
Summary: The 'List Global OAuth Clients' API endpoint allows administrators to retrieve a list of all global OAuth clients that users on their account have authorized. The endpoint supports cursor and offset pagination, returning a maximum of 100 records per page. The request requires basic authentication using an email address and API token. The response includes a list of global OAuth clients, each with an ID and name.
Input Fields: Input Fields
Output Fields: Output Fields

List Group Memberships

ID: get_list_group_memberships
Operation: read
Entities: group membership, group, user
Summary: The List Group Memberships API allows agents to retrieve a list of group memberships. It supports cursor and offset pagination, returning a maximum of 100 records per page. The API requires authentication via basic auth using an email address and API token. The endpoint can be accessed in three ways: to list all memberships, to list memberships by group ID, or to list memberships by user ID. The response includes details such as creation date, default status, group ID, membership ID, last update date, and user ID.
Input Fields: Input Fields
Output Fields: Output Fields

List Group SLA Policies

ID: get_list_group_sla_policies
Operation: read
Entities: group, priority, SLA policy
Summary: The 'List Group SLA Policies' API endpoint allows administrators to retrieve a list of SLA policies associated with groups. The request requires authentication via email and API token, and the 'Content-Type' header must be set to 'application/json'. The response includes a count of the SLA policies and an array of policy details, such as description, filter criteria, metrics, position, title, and URL. The response also provides pagination information with 'next_page' and 'previous_page' URLs.
Input Fields: Input Fields
Output Fields: Output Fields

List Groups

ID: get_list_groups
Operation: read
Entities: user, group
Summary: The List Groups API allows admins and agents to retrieve a list of groups. It supports cursor and offset pagination, returning a maximum of 100 records per page. The API can be accessed via two endpoints: '/api/v2/groups' and '/api/v2/users/{user_id}/groups'. The 'exclude_deleted' query parameter can be used to filter out deleted entities. The 'user_id' path parameter is required when accessing the user-specific endpoint. The response includes details about each group, such as creation date, ID, public status, name, and last update date.
Input Fields: Input Fields
Output Fields: Output Fields

List Holidays for Schedule

ID: get_list_holidays_for_schedule
Operation: read
Entities: business hour, holiday, schedule
Summary: The 'List Holidays for Schedule' API endpoint allows administrators to retrieve a list of holidays for a specific schedule. The endpoint requires the 'schedule_id' as a path parameter. Optionally, 'start_date' and 'end_date' can be provided as query parameters in ISO 8601 date format to filter holidays starting on or after the 'start_date' and on or before the 'end_date'. If no dates are specified, all holidays are returned. The response includes an array of holidays, each with details such as 'id', 'name', 'start_date', and 'end_date'.
Input Fields: Input Fields
Output Fields: Output Fields

List Identities

ID: get_list_identities
Operation: read
Entities: agent, identity, user
Summary: The List Identities API allows agents and verified end users to retrieve a list of identities associated with a specific user. The API supports cursor and offset pagination, returning a maximum of 100 records per page. The request requires a user ID as a path parameter and supports optional filtering by identity types such as email, facebook, phone_number, sdk, twitter, messaging, or microsoft. The response includes details of each identity, such as creation date, identity ID, primary status, type, last update date, user ID, value, and verification status.
Input Fields: Input Fields
Output Fields: Output Fields

List Job Statuses

ID: get_list_job_statuses
Operation: read
Entities: agent, background job, job status
Summary: The 'List Job Statuses' API endpoint allows agents to retrieve the statuses of background jobs. The statuses are sorted by completion date and then by creation date in descending order. This endpoint uses cursor pagination. The request requires basic authentication with an email address and API token. The response includes a list of job statuses, each with a unique identifier and status.
Input Fields: Input Fields
Output Fields: Output Fields

List Links

ID: get_list_links
Operation: read
Entities: link, admin, account
Summary: The List Links API endpoint retrieves a list of links for the current account, ordered by ID. It is accessible to admins and supports pagination with a default of 1000 links per page. The API allows filtering by ticket or issue ID using the 'filter[ticket_id]' query parameter. Pagination can be controlled using 'page[after]' and 'page[size]' query parameters. The response includes a list of links with details such as creation date, link ID, issue ID, issue key, ticket ID, and last update date, along with pagination metadata indicating the next page URL and whether more results are available.
Input Fields: Input Fields
Output Fields: Output Fields

List Locales

ID: get_list_locales
Operation: read
Entities: locale, translation, account setting
Summary: The List Locales API endpoint retrieves a list of translation locales available for a Zendesk account. It requires basic authentication using an email address and API token. The request is made to the subdomain-specific URL in the format https://{subdomain}.zendesk.com/api/v2/locales.json. The response includes a list of locales, each with details such as creation date, unique identifier, locale code, name, last update date, and URL. This API is accessible to anyone with the appropriate credentials.
Input Fields: Input Fields
Output Fields: Output Fields

List Locales for Agent

ID: get_list_locales_for_agent
Operation: read
Entities: agent, account, locale
Summary: The 'List Locales for Agent' API endpoint allows users to retrieve a list of translation locales that have been localized for agents on a specific account. This API uses a GET request to the '/api/v2/locales/agent' endpoint. The request requires basic authentication using an email address and API token. The response includes a list of locales, each with details such as creation date, unique ID, locale code, name, last update date, and URL.
Input Fields: Input Fields
Output Fields: Output Fields

List Location Installations

ID: get_list_location_installations
Operation: read
Entities: location installation, installation, location
Summary: The 'List Location Installations' API endpoint allows administrators to retrieve a list of app installations across different locations within the Zendesk platform. The request requires basic authentication using an email address and API token. The response includes a list of location installations, each containing installation IDs and the corresponding location name.
Input Fields: Input Fields
Output Fields: Output Fields

List Locations for Zendesk Apps

ID: get_list_locations_for_zendesk_apps
Operation: read
Entities: app, location, host application
Summary: The 'List Locations for Zendesk Apps' API endpoint allows administrators to retrieve a list of available locations where Zendesk apps can be placed. The request requires basic authentication using an email address and API token. The response includes a list of locations, each with details such as the host application, unique identifier, name, and whether the location is orderable.
Input Fields: Input Fields
Output Fields: Output Fields

List Macro Categories

ID: get_list_macro_categories
Operation: read
Entities: agent, macro, category
Summary: The 'List Macro Categories' API endpoint allows agents to retrieve a list of all macro categories available to the current user. It requires basic authentication using an email address and API token. The request does not require any path parameters, query parameters, or request body. The response includes a list of categories in JSON format, with a '200 OK' status indicating success.
Input Fields: Input Fields
Output Fields: Output Fields

List Macros

ID: get_list_macros
Operation: read
Entities: agent, admin, macro
Summary: The List Macros API endpoint allows users to retrieve a list of all shared and personal macros available to the current user. For admins, it returns all macros for the account, including personal macros of agents and other admins. The API supports cursor and offset pagination, returning a maximum of 100 records per page. Users can filter macros by access, active status, category, group, and other parameters. Sideloads such as app installation, categories, permissions, and usage statistics can be included in the response. The response includes the count of macros, a list of macro details, and pagination information.
Input Fields: Input Fields
Output Fields: Output Fields

List Monitored X Handles

ID: get_list_monitored_x_handles
Operation: read
Entities: agent, admin, twitter handle
Summary: The 'List Monitored X Handles' API allows Admins and Agents to retrieve a list of Twitter handles that are being monitored. This API does not require any specific headers, path parameters, query parameters, or request body. The response includes a list of monitored Twitter handles, each with details such as the creation date, unique identifier, screen name, Twitter user ID, and the last update date.
Input Fields: Input Fields
Output Fields: Output Fields

List OAuth Clients

ID: get_list_oauth_clients
Operation: read
Entities: user, admin, oauth client
Summary: The List OAuth Clients API allows administrators to retrieve a list of OAuth clients associated with their Zendesk account. The API supports cursor and offset pagination, returning a maximum of 100 records per page. The request requires basic authentication using an email and API token. The response includes details about each client, such as company name, creation date, description, identifier, name, redirect URIs, secret, update date, URL, and associated user ID.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Fields

ID: get_list_organization_fields
Operation: read
Entities: agent, organization, organization field
Summary: The List Organization Fields API endpoint allows agents to retrieve a list of custom organization fields configured in their Zendesk account. The fields are returned in the order specified in the organization's field configuration. This API supports cursor and offset pagination, returning a maximum of 100 records per page. The response includes details such as the field's active status, creation and update timestamps, description, key, position, title, type, and URL. Clients are advised to cache the results for the duration of their API usage.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Memberships

ID: get_list_organization_memberships
Operation: read
Entities: user, organization, organization membership
Summary: The List Organization Memberships API retrieves a list of organization memberships for the account, a specific user, or a specific organization. It supports cursor and offset pagination, returning a maximum of 100 records per page. The API requires basic authentication and can be accessed by agents and end users. The response includes details such as the creation date, default status, membership ID, organization ID and name, last update date, user ID, and whether the user can view tickets.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Merges

ID: get_list_organization_merges
Operation: read
Entities: organization, merge operation
Summary: The 'List Organization Merges' API endpoint retrieves a list of all organization merge operations associated with a given organization. It allows tracking the history of merge actions, including ongoing and completed merges. The endpoint uses cursor pagination, with a maximum of 100 records per page. It is accessible to admins. The primary input parameter is 'organization_id', which is required and specified in the path. The response includes details such as the merge ID, winning and losing organization IDs, the status of the merge, and a URL to access the Organization Merge record.
Input Fields: Input Fields
Output Fields: Output Fields

List Organization Subscriptions

ID: get_list_organization_subscriptions
Operation: read
Entities: organization subscription, organization, user
Summary: The 'List Organization Subscriptions' API endpoint allows agents and end users to retrieve a list of organization subscriptions. The endpoint supports cursor and offset pagination, returning a maximum of 100 records per page. The response includes details such as the creation date, subscription ID, organization ID, and user ID. For end users, only subscriptions created by the requesting user are listed. Authentication is required using a basic token in the headers.
Input Fields: Input Fields
Output Fields: Output Fields

List Organizations

ID: get_list_organizations
Operation: read
Entities: agent, organization, user
Summary: The List Organizations API allows agents to retrieve a list of organizations. It supports both cursor and offset pagination, returning a maximum of 100 records per page. The API requires basic authentication using an email address and API token. Agents with restricted roles may encounter a 403 Forbidden error if their access is limited to users within their own organization. The response includes details such as organization name, domain names, external ID, and custom fields. The API can be accessed via the general endpoint or a user-specific endpoint by providing a user ID.
Input Fields: Input Fields
Output Fields: Output Fields

List Owned Apps

ID: get_list_owned_apps
Operation: read
Entities: app, parameter, category
Summary: The 'List Owned Apps' API endpoint allows users to retrieve a list of apps owned by the current account. It is accessible to admins and sideloads. The API requires basic authentication and supports optional query parameters to exclude certain objects from the response. The response includes detailed information about each app, such as author details, categories, creation date, installation instructions, and more.
Input Fields: Input Fields
Output Fields: Output Fields

List Password Requirements

ID: get_list_password_requirements
Operation: read
Entities: requirement, user, password
Summary: The 'List Password Requirements' API endpoint allows agents and end users to retrieve the password requirements for a specific user by their user ID. The request requires the 'user_id' as a path parameter, which is mandatory. The response returns a list of password requirements, such as minimum character length and restrictions on using the email address as a password.
Input Fields: Input Fields
Output Fields: Output Fields

List Reasons for Satisfaction Rating

ID: get_list_reasons_for_satisfaction_rating
Operation: read
Entities: reason, admin, account
Summary: The 'List Reasons for Satisfaction Rating' API endpoint allows administrators to retrieve a list of all satisfaction reasons associated with an account. The request requires basic authentication using an email address and API token. The endpoint is accessed via a GET request to the specified URL, which includes the subdomain of the Zendesk account. The response includes a list of reasons, each with details such as creation date, unique identifier, raw value, reason code, last update date, URL, and description.
Input Fields: Input Fields
Output Fields: Output Fields

List Requests

ID: get_list_requests
Operation: read
Entities: user, organization, request
Summary: The List Requests API allows end users to retrieve a list of requests. The API supports cursor and offset pagination. Users can filter requests by status and sort them by 'updated_at' or 'created_at' in ascending or descending order. The API requires basic authentication using an email and API token. The response includes a list of requests with details such as request ID, status, creation date, and last update date.
Input Fields: Input Fields
Output Fields: Output Fields

List Resource Collections

ID: get_list_resource_collections
Operation: read
Entities: resource, resource collection, admin
Summary: The 'List Resource Collections' API endpoint allows administrators to retrieve a list of resource collections associated with their account. The request requires basic authentication using an email address and API token. The response includes the total count of resource collections, pagination information, and details of each resource collection, including creation and update timestamps, resource identifiers, and types.
Input Fields: Input Fields
Output Fields: Output Fields

List Resource Tags

ID: get_list_resource_tags
Operation: read
Entities: user, organization, ticket
Summary: The 'List Resource Tags' API allows agents to retrieve a list of tags associated with a specific ticket. The API requires the 'ticket_id' as a path parameter to identify the ticket whose tags are to be retrieved. The request must include an Authorization header with a basic authentication token. The response returns a list of tags in JSON format, with a 200 OK status indicating a successful retrieval.
Input Fields: Input Fields
Output Fields: Output Fields

List Satisfaction Ratings

ID: get_list_satisfaction_ratings
Operation: read
Entities: user, ticket, satisfaction rating
Summary: The 'List Satisfaction Ratings' API allows admins to retrieve a list of satisfaction ratings. It supports cursor and offset pagination. The API can be filtered by score, start_time, and end_time. The score filter can include values such as 'good', 'bad', and their variations with or without comments. The response includes details like assignee_id, comment, created_at, group_id, id, requester_id, score, ticket_id, updated_at, and url for each satisfaction rating.
Input Fields: Input Fields
Output Fields: Output Fields

List Search Results

ID: get_list_search_results
Operation: read
Entities: rate limit, error, search result
Summary: The List Search Results API allows agents to retrieve search results based on a query string. The API supports optional sorting parameters such as 'sort_by' and 'sort_order'. The response includes the total count of results, pagination links, and an array of result objects with details like creation and update timestamps, IDs, names, and URLs. The API has a specific rate limit, and usage information is provided in the response headers. Errors are returned in a JSON format with 'error' and 'description' fields.
Input Fields: Input Fields
Output Fields: Output Fields

List Sessions

ID: get_list_sessions
Operation: read
Entities: user, session, account
Summary: The List Sessions API allows admins, agents, and end users to retrieve session information. When authenticated as an admin, all account sessions are returned. When authenticated as an agent or end user, only the sessions of the user making the request are returned. The API supports cursor and offset pagination. The request requires a user_id as a path parameter and basic authentication in the headers. The response includes session details such as authentication time, session ID, last seen time, session URL, and user ID.
Input Fields: Input Fields
Output Fields: Output Fields

List Side Conversation Events

ID: get_list_side_conversation_events
Operation: read
Entities: side conversation, ticket, event
Summary: The 'List Side Conversation Events' API endpoint allows agents to retrieve a list of events associated with a specific side conversation within a ticket. The API requires the 'ticket_id' and 'side_conversation_id' as path parameters. The response includes details about each event, such as the actor's information, message content, and event type. The API supports pagination, with 'next_page' and 'previous_page' fields in the response.
Input Fields: Input Fields
Output Fields: Output Fields

List Side Conversations

ID: get_list_side_conversations
Operation: read
Entities: side conversation, ticket, event
Summary: The 'List Side Conversations' API endpoint allows agents to retrieve a list of side conversations associated with a specific ticket. The request requires the 'ticket_id' as a path parameter and an authorization header for authentication. The response includes an array of side conversations, each with an ID and potentially a 'targetTicketId' if the side conversation is a child ticket.
Input Fields: Input Fields
Output Fields: Output Fields

List SLA Policies

ID: get_list_sla_policies
Operation: read
Entities: incident, priority, SLA policy
Summary: The List SLA Policies API allows administrators to retrieve a list of SLA policies available in their Zendesk account. This API is accessible to accounts on the Support Professional or Suite Growth plan or above. The request requires basic authentication using an email address and API token. The response includes details such as the count of SLA policies, pagination information, and an array of SLA policy objects, each containing a description, filter criteria, policy metrics, position, title, and URL.
Input Fields: Input Fields
Output Fields: Output Fields

List Support Addresses

ID: get_list_support_addresses
Operation: read
Entities: recipient address, account, brand
Summary: The List Support Addresses API endpoint allows admins and agents to retrieve a list of all support addresses associated with their account. The API uses cursor or offset pagination and returns a maximum of 100 records per page. The request requires basic authentication using an email address and API token. The response includes details such as brand ID, CNAME status, creation and update timestamps, default status, domain verification status, email, forwarding status, ID, name, and SPF status for each support address.
Input Fields: Input Fields
Output Fields: Output Fields

List Supported Actions for Macros

ID: get_list_supported_actions_for_macros
Operation: read
Entities: agent, action, macro
Summary: The 'List Supported Actions for Macros' API endpoint allows agents to retrieve a list of actions that can be used in macros. The request is made using a GET method to the URL '/api/v2/macros/actions'. The request requires an Authorization header with a basic authentication token. The response includes a list of actions, each with an ID and name, in the response body.
Input Fields: Input Fields
Output Fields: Output Fields

List Tags

ID: get_list_tags
Operation: read
Entities: agent, tag
Summary: The List Tags API endpoint retrieves up to 20,000 of the most popular tags used in the last 60 days, sorted by popularity. It supports cursor and offset pagination, returning a maximum of 100 records per page. This endpoint is accessible to agents and has its own rate limit, separate from the account-wide limit. The response includes rate limit information in the headers. The API requires basic authentication using an email and API token. The response includes the total count of tags, pagination URLs, and an array of tag objects with their usage count and name.
Input Fields: Input Fields
Output Fields: Output Fields

List Target Failures

ID: get_list_target_failures
Operation: read
Entities: target failure, target, admin
Summary: The 'List Target Failures' API endpoint retrieves the 25 most recent target failures for each target. It is accessible via a GET request to '/api/v2/target_failures'. This API is in the development stage and is allowed for Admin users only. The request requires basic authentication using an email address and API token. The response includes a list of target failures, each with an ID, HTTP status code, and target name.
Input Fields: Input Fields
Output Fields: Output Fields

List Targets

ID: get_list_targets
Operation: read
Entities: agent, target
Summary: The 'List Targets' API endpoint allows agents to retrieve a list of targets from the Zendesk system. This is a GET request to the '/api/v2/targets' endpoint. The request requires basic authentication using an email address and API token. The response includes a list of targets, each with details such as whether it is active, its creation date, unique identifier, title, and type. The response is returned in JSON format.
Input Fields: Input Fields
Output Fields: Output Fields

List Ticket Fields

ID: get_list_ticket_fields
Operation: read
Entities: user, ticket field, locale
Summary: The List Ticket Fields API endpoint retrieves a list of all system and custom ticket fields in your account. It supports cursor pagination, returning a maximum of 100 records per page. The API allows filtering by creator and locale through query parameters. The response includes detailed information about each ticket field, such as its ID, description, position, and visibility in the portal. The API also provides rate limit information in the response headers. This endpoint is accessible to anyone and has its own rate limit separate from the account-wide limit.
Input Fields: Input Fields
Output Fields: Output Fields

List Ticket Forms

ID: get_list_ticket_forms
Operation: read
Entities: end user, ticket form, account
Summary: The List Ticket Forms API endpoint retrieves a list of all ticket forms for your account. It is accessible to admins and agents, while end users only see ticket forms with end_user_visible set to true. The API supports several query parameters: 'active' to filter active or inactive forms, 'associated_to_brand' to filter forms by brand, 'end_user_visible' to filter forms visible to end users, and 'fallback_to_default' to return the default form if no active and visible forms match the criteria. The response includes a list of ticket forms with details such as ID, name, visibility, and active status.
Input Fields: Input Fields
Output Fields: Output Fields

List Ticket Incidents

ID: get_list_ticket_incidents
Operation: read
Entities: agent, incident, ticket
Summary: The 'List Ticket Incidents' API retrieves a list of incidents associated with a specific ticket. It requires the 'ticket_id' as a path parameter to identify the ticket. The API uses basic authentication with an email address and API token. The response includes a list of incidents, each with details such as description, ID, status, and subject. The API supports cursor and offset pagination for handling large datasets.
Input Fields: Input Fields
Output Fields: Output Fields

List Ticket Metrics

ID: get_list_ticket_metrics
Operation: read
Entities: agent, ticket, metric
Summary: The List Ticket Metrics API endpoint retrieves a list of tickets along with their associated metrics, ordered chronologically by creation date from newest to oldest. The response excludes archived tickets and supports pagination with a maximum of 100 records per page. This API is accessible to agents and requires basic authentication. The response includes ticket IDs, creation dates, and metrics such as response and resolution times.
Input Fields: Input Fields
Output Fields: Output Fields

List Ticket Problems

ID: get_list_ticket_problems
Operation: read
Entities: agent, problem, ticket
Summary: The 'List Ticket Problems' API endpoint allows agents to retrieve a list of ticket problems. The response is ordered by the 'updated_at' field in descending order. This API supports both cursor and offset pagination. The request requires basic authentication using an email address and API token. The response includes a list of tickets, each with details such as custom status ID, description, ticket ID, status, and subject.
Input Fields: Input Fields
Output Fields: Output Fields

List Ticket Skips

ID: get_list_ticket_skips
Operation: read
Entities: agent, ticket, user
Summary: The List Ticket Skips API allows agents with 'View only' or higher reports permissions in Support to retrieve a list of ticket skips. The API supports cursor and offset pagination, returning a maximum of 100 records per page. The endpoint requires the user_id as a path parameter and optionally accepts a sort_order query parameter to specify the order of the results. The response includes a list of skips with details such as skip ID, ticket ID, user ID, and creation timestamp. Archived tickets are not included in the response.
Input Fields: Input Fields
Output Fields: Output Fields

List Ticket Triggers

ID: get_list_ticket_triggers
Operation: read
Entities: agent, ticket, trigger
Summary: The List Ticket Triggers API endpoint allows agents to retrieve a list of all ticket triggers for the current account. It supports cursor and offset pagination, returning a maximum of 100 records per page. The API can filter triggers by their active status, category ID, and sort them based on various criteria such as creation date or usage. The response includes details about each trigger, such as its actions, conditions, and metadata like creation and update timestamps. This API is accessible to agents and supports sideloads for additional data like app installations and usage statistics.
Input Fields: Input Fields
Output Fields: Output Fields

List Tickets

ID: get_list_tickets
Operation: read
Entities: user, organization, ticket
Summary: The List Tickets API allows agents to retrieve a list of tickets from the Zendesk system. It supports various endpoints to list tickets by organization, user, or recent activity. The API supports cursor and offset pagination, with sorting options available for both methods. Query parameters include 'external_id' for filtering tickets by external ID. The API returns ticket details such as assignee, collaborators, creation date, status, and more. Rate limit information is provided in the response headers. This API is intended for agents and returns a maximum of 100 records per page.
Input Fields: Input Fields
Output Fields: Output Fields

List Tickets From a View

ID: get_list_tickets_from_a_view
Operation: read
Entities: agent, ticket, view
Summary: The 'List Tickets From a View' API allows agents to retrieve a list of tickets from a specified view. The API uses cursor or offset pagination. The 'view_id' is a required path parameter that specifies the ID of the view. Optional query parameters include 'sort_by' to sort or group tickets by a column in the View columns table, and 'sort_order' to specify the order of sorting, either 'asc' or 'desc'. The response includes a list of tickets with their IDs, requester IDs, and subjects.
Input Fields: Input Fields
Output Fields: Output Fields

List Tickets Fulfilled by a User

ID: get_list_tickets_fulfilled_by_a_user
Operation: read
Entities: agent, ticket, user
Summary: The 'List Tickets Fulfilled by a User' API endpoint allows agents and admins to retrieve a list of ticket IDs that have attributes matching the current user's attributes. The API requires a query parameter 'ticket_ids', which is an array of integers representing the IDs of the relevant tickets to check. The request must include an Authorization header for authentication. The response returns a JSON object containing 'fulfilled_ticket_ids', which is an array of ticket IDs that match the user's attributes.
Input Fields: Input Fields
Output Fields: Output Fields

List Tokens

ID: get_list_tokens
Operation: read
Entities: user, token, client
Summary: The List Tokens API endpoint allows users to retrieve the properties of OAuth tokens for the current user. Admins can view OAuth token properties for all users by using the 'all' query parameter. The 'client_id' query parameter can be used to filter the list by a specific OAuth client ID. For security reasons, only the first 10 characters of each access token are included in the response. The API supports both cursor and offset pagination, returning a maximum of 100 records per page. The request requires an Authorization header with a basic authentication token. The response includes details such as client_id, created_at, expires_at, id, refresh_token, scopes, token, url, used_at, and user_id for each token.
Input Fields: Input Fields
Output Fields: Output Fields

List User Fields

ID: get_list_user_fields
Operation: read
Entities: agent, user field, user
Summary: The 'List User Fields' API endpoint retrieves a list of custom user fields configured in your Zendesk Support account. The fields are returned in the order specified in your user fields configuration. This API supports cursor and offset pagination, returning a maximum of 100 records per page. It is accessible to agents and requires basic authentication using an email address and API token. The response includes details such as the field's active status, creation and update timestamps, description, ID, key, position, title, type, and URL.
Input Fields: Input Fields
Output Fields: Output Fields

List Users

ID: get_list_users
Operation: read
Entities: user, organization, group
Summary: The List Users API allows admins, agents, and light agents to retrieve a list of users from the Zendesk platform. The API supports cursor and offset pagination, returning a maximum of 100 records per page. Users can be filtered by external ID, permission set, and role. The API supports filtering by multiple roles using the role[] query parameter. The response includes a list of users with their IDs and names.
Input Fields: Input Fields
Output Fields: Output Fields

List Variants of Dynamic Content Item

ID: get_list_variants_of_dynamic_content_item
Operation: read
Entities: variant, admin, dynamic content item
Summary: The 'List Variants of Dynamic Content Item' API endpoint allows users to retrieve all variants associated with a specific dynamic content item. This endpoint is accessible to admins and agents with permission to manage dynamic content. It uses cursor pagination for handling large sets of data. The request requires the 'dynamic_content_item_id' as a path parameter to specify the dynamic content item. The response includes a list of variants, each containing details such as 'active' status, 'content', 'created_at', 'default' status, 'id', 'locale_id', 'outdated' status, 'updated_at', and 'url'.
Input Fields: Input Fields
Output Fields: Output Fields

List Views

ID: get_list_views
Operation: read
Entities: agent, view, pagination
Summary: The List Views API endpoint allows agents to retrieve a list of shared and personal views available to the current user. It supports sideloading of app installations and permissions for each view. The API uses cursor and offset pagination, returning a maximum of 100 records per page. Query parameters include 'access' to filter views by access type, 'active' to filter by active status, 'group_id' to filter by group, 'sort_by' to specify sorting criteria, and 'sort_order' to define the sorting order. The response includes the count of views, pagination links, and details of each view such as its active status, description, ID, position, and title.
Input Fields: Input Fields
Output Fields: Output Fields

List Views By ID

ID: get_list_views_by_id
Operation: read
Entities: agent, view, app installation
Summary: The 'List Views By ID' API allows agents to retrieve multiple views by their IDs. The API requires the 'ids' query parameter, which is a comma-separated list of view IDs. An optional 'active' query parameter can be used to filter views based on their active status. The response includes the count of views, pagination details, and an array of view objects, each containing details such as active status, description, ID, position, and title.
Input Fields: Input Fields
Output Fields: Output Fields

List Views - Compact

ID: get_list_views_compact
Operation: read
Entities: agent, ticket, view
Summary: The 'List Views - Compact' API endpoint provides a compacted list of shared and personal views available to the current user. It is accessible via a GET request to '/api/v2/views/compact'. The endpoint requires basic authentication using an email address and API token. The response includes a maximum of 32 view records, each containing details such as active status, conditions, description, execution details, ID, position, restrictions, and title. The response also includes pagination information with 'next_page' and 'previous_page' fields, which are null if there are no additional pages.
Input Fields: Input Fields
Output Fields: Output Fields

List Workspaces

ID: get_list_workspaces
Operation: read
Entities: macro, condition, workspace
Summary: The List Workspaces API allows Admins and Agents to retrieve a list of workspaces from the Zendesk platform. The API endpoint is accessed via a GET request to /api/v2/workspaces. Users can optionally specify a 'per_page' query parameter to limit the number of workspaces returned per page. The response includes a count of total workspaces, pagination links, and detailed information about each workspace, such as activation status, associated apps, conditions, macros, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Listing Comments for a Request

ID: get_listing_comments_for_a_request
Operation: read
Entities: comment, pagination, request
Summary: This API endpoint retrieves a list of comments for a specific request identified by the request_id. It supports both cursor and offset pagination, allowing sorting by creation or update date in ascending or descending order. The API can filter comments based on the role (agent or end_user) and a specified datetime. The response includes a list of comments with their content and IDs.
Input Fields: Input Fields
Output Fields: Output Fields

List Macro Action Definitions

ID: get_macro_action_definitions
Operation: read
Entities: macro, definition, action
Summary: The 'List Macro Action Definitions' API endpoint allows agents to retrieve the definitions of actions that a macro can perform in the Zendesk system. This includes details such as the action's group, whether it is nullable or repeatable, its subject, title, type, and possible values. The API requires basic authentication using an email address and API token. The response includes a list of actions with their respective properties and possible values, such as ticket status options like Open, Pending, Solved, and Closed.
Input Fields: Input Fields
Output Fields: Output Fields

List Macro Attachments

ID: get_macro_attachments
Operation: read
Entities: agent, attachment, macro
Summary: The 'List Macro Attachments' API endpoint allows agents to retrieve a list of attachments associated with a specific macro. The request requires the 'macro_id' as a path parameter to identify the macro. The response includes an array of attachments, each with details such as content type, content URL, creation date, filename, ID, and size. Authentication is required via a basic authentication token in the request headers.
Input Fields: Input Fields
Output Fields: Output Fields

Show Monitored Twitter Handle

ID: get_monitored_twitter_handle
Operation: read
Entities: agent, admin, twitter handle
Summary: The 'Show Monitored Twitter Handle' API endpoint retrieves details of a monitored Twitter handle by its ID. It is accessible to Admins and Agents. The request requires the 'monitored_twitter_handle_id' as a path parameter, which is the ID of the custom agent role. The response includes details such as the creation date, ID, screen name, Twitter user ID, and the last update date of the monitored Twitter handle.
Input Fields: Input Fields
Output Fields: Output Fields