get_sources_by_target
Retrieve source entities linked to a specific target entity through a defined relationship field.
Hosted MCP integration
Zendesk MCP server
The Zendesk MCP server allows you to interact with Zendesk APIs from any AI agent and agent assistants
This integration is deprecated. Review its availability before installing.
What you can do
Give your agent access to the enabled tools in this release, including:
- Search users: Search for users with filters like query, external ID, brand ID, and pagination options.
- Search automations: Search automations with filters for query, status, sorting, and included fields to find specific automation workflows efficiently.
- Search custom object records: Search records within a specified custom object using query, sorting, and pagination parameters.
- Search object triggers: Retrieve and search triggers for a specified custom object using filters, query, sorting, and inclusion options.
- Search itam assets: Search and retrieve IT assets using query filters, sorting, and pagination options.
- Search macro: Search and filter macros by category, access, status, group, and sorting options to find specific automation scripts quickly.
How to connect Zendesk to your AI agent
- Sign in to ToolPlane and install this release into your project.
- Configure your own provider credentials and any account-specific settings.
- Review enabled tools and permissions, deploy the server, then add its MCP endpoint to your compatible agent client.
Provider-specific setup instructions have not been published for this integration. Confirm the required account settings before enabling it.
Authentication and permissions
Installation requires a ToolPlane account. Provider authorization is configured separately with your own credentials. Available operations depend on the permissions granted by your provider account.
Verification and limitations
Verified 2026-11-09. This was tested with several AI agents and agentic flows. This server itself exposes about 676 tools. You probably won't need all of them so you can enable just what you need. See Zendesk's public API documentation for more details about each tool. https://developer.zendesk.com/api-reference/
Only the tools listed for this release are included. Review the verification notes and enable the operations appropriate for your use case. Future releases do not automatically change an installed copy.
Release notes
Initial release
About this integration
This listing is published on ToolPlane. The provider name identifies the connected service; inclusion in the registry does not by itself imply provider endorsement. The source release, supported tools and verification notes are shown here so you can assess it before installing.
Available tools
get_account_email_settings
Retrieve the current email notification and preference settings for the user account.
Example request and response
{
"response": {
"settings": {
"email": {
"email_status": true,
"gmail_actions": true,
"mail_delimiter": "##- Please type your reply above this line -##",
"no_mail_delimiter": false,
"custom_dkim_domain": false,
"html_mail_template": "<html>...</html>",
"text_mail_template": "...",
"personalized_replies": true,
"email_template_photos": true,
"modern_email_template": true,
"accept_wildcard_emails": true,
"gmail_fallback_enabled": true,
"rich_content_in_emails": true,
"email_template_selection": false,
"email_sender_authentication": true,
"multi_recipient_email_tickets": true,
"send_gmail_messages_via_gmail": false,
"email_sender_authentication_profile": "default"
}
}
}
}update_account_email_settings
Update the user's email notification preferences by modifying their email settings.
Example request and response
{
"request": {
"settings": {
"email": {
"personalized_replies": true,
"rich_content_in_emails": true,
"multi_recipient_email_tickets": true
}
}
},
"response": {
"settings": {
"email": {
"email_status": true,
"gmail_actions": true,
"mail_delimiter": "##- Please type your reply above this line -##",
"no_mail_delimiter": false,
"custom_dkim_domain": false,
"html_mail_template": "<html>...</html>",
"text_mail_template": "...",
"personalized_replies": true,
"email_template_photos": true,
"modern_email_template": true,
"accept_wildcard_emails": true,
"gmail_fallback_enabled": true,
"rich_content_in_emails": true,
"email_template_selection": false,
"email_sender_authentication": true,
"multi_recipient_email_tickets": true,
"send_gmail_messages_via_gmail": false,
"email_sender_authentication_profile": "default"
}
}
}
}show_account_settings
Retrieve current user account settings using an authenticity token for authentication.
Example request and response
{
"response": {
"settings": {
"brands": {
"default_brand_id": 1873,
"require_brand_on_new_tickets": false,
"end_user_across_brand_requests": false,
"new_agent_brand_association_behavior": "all_brands",
"end_user_upgrade_brand_association_behavior": "previous_brands"
}
}
}
}update_account_settings
Update user account settings by sending new configuration parameters.
Example request and response
{
"response": {
"settings": {
"brands": {
"default_brand_id": 1873,
"require_brand_on_new_tickets": false,
"end_user_across_brand_requests": false,
"new_agent_brand_association_behavior": "all_brands",
"end_user_upgrade_brand_association_behavior": "previous_brands"
}
}
}
}create_trial_account
Create a trial account with specified details including account info, address, agents, owner, partner, trial extras, and optional pod assignment.
verify_subdomain_availability
Check if a given subdomain is available for registration by providing the subdomain name.
Example request and response
{
"response": {
"success": true
}
}list_activities
Retrieve a paginated list of activities with optional filters for date, sorting, and included related data.
show_activity
Retrieve detailed information about a specific activity using its unique activity ID.
count_activities
Retrieve the total number of activities recorded without requiring any parameters.
report_channelback_error
Report a channelback error by submitting details via POST to the designated error reporting endpoint.
push_content_to_support
Send content directly to support channels for assistance or review.
validate_token
Verify the authenticity and validity of a provided token via a POST request.
list_api_tokens
Retrieve a list of API tokens, optionally including associated user details.
create_api_token
Generate a new API token by providing the required token details in the request.
update_api_token
Update an API token by specifying its ID and new token value.
delete_api_token
Delete an API token by its unique ID.
create_approval_clarification_flow_message
Create a message requesting clarification for an approval, including message content and delivery method.
Example request and response
{
"request": {
"message": "Can you clarify the budget line?",
"approval_request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV"
},
"response": {
"approval_request_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"clarification_flow_messages": [
{
"id": "msg_123",
"via": "SUPPORT",
"author": {
"id": 12345,
"name": "Jane Doe",
"role": "end_user",
"avatar": "https://company.zendesk.com/system/photos/12345/avatar.png"
},
"message": "Can you clarify the budget line?",
"created_at": "2026-09-29T14:32:00Z"
}
]
}
}show_approval_clarification_flow_messages
Retrieve clarification messages for a specific approval request by its ID.
list_approval_requests
Retrieve a filtered list of approval requests with optional pagination and related data inclusion.
create_approval_request
Create an approval request with details like subject, message, assignees, attachments, metadata, and associated ticket ID.
show_approval_workflow_instance_approval_request
Retrieve details of a specific approval request within a given approval workflow instance by its IDs.
Example request and response
{
"response": {
"approval_request": {
"id": "01KFP3S9EVXF9CKAYY080NV98C",
"status": "active",
"message": "Please approve this request for a new laptop",
"subject": "Laptop Purchase Approval",
"decisions": [],
"created_at": "2026-01-23T19:02:36Z",
"decided_at": null,
"assignee_user": {
"id": 456,
"name": "Jane Approver",
"photo": {
"content_url": "https://company.zendesk.com/system/photos/456/photo.png"
}
},
"assignee_group": null,
"ticket_details": {
"id": 123,
"status": "open",
"priority": "normal",
"requester": {
"id": 789,
"name": "John Requester"
},
"custom_fields": []
},
"created_by_user": {
"id": 789,
"name": "John Requester",
"photo": {
"content_url": "https://company.zendesk.com/system/photos/789/photo.png"
}
},
"origination_type": "API_ORIGINATION",
"withdrawn_reason": null,
"approval_workflow_instance_id": "01KFP3S9EVXF9CKAYY080NV98D"
}
}
}decide_approval_request
Submit a decision with notes to approve or reject a specific approval request within a workflow instance.
Example request and response
{
"request": {
"notes": "Looks good, approved",
"status": "approved"
},
"response": {
"approval_request": {
"id": "01KFP3S9EVXF9CKAYY080NV98C",
"status": "approved",
"message": "Please approve this request for a new laptop",
"subject": "Laptop Purchase Approval",
"decisions": [
{
"status": "approved",
"decided_at": "2026-01-23T19:10:00Z",
"decision_notes": "Looks good, approved",
"decided_by_user": {
"id": 456,
"name": "Jane Approver",
"photo": {
"content_url": "https://company.zendesk.com/system/photos/456/photo.png"
}
}
}
],
"created_at": "2026-01-23T19:02:36Z",
"decided_at": "2026-01-23T19:10:00Z",
"assignee_user": {
"id": 456,
"name": "Jane Approver",
"photo": {
"content_url": "https://company.zendesk.com/system/photos/456/photo.png"
}
},
"assignee_group": null,
"ticket_details": {
"id": 123,
"status": "open",
"priority": "normal",
"requester": {
"id": 789,
"name": "John Requester"
},
"custom_fields": []
},
"created_by_user": {
"id": 789,
"name": "John Requester",
"photo": {
"content_url": "https://company.zendesk.com/system/photos/789/photo.png"
}
},
"origination_type": "API_ORIGINATION",
"withdrawn_reason": null,
"approval_workflow_instance_id": "01KFP3S9EVXF9CKAYY080NV98D"
}
}
}withdraw_approval_workflow_instance
Withdraw an approval workflow instance by ID, providing a reason for withdrawal.
Example request and response
{
"request": {
"withdrawn_reason": "No longer needed"
}
}show_attachment
Retrieve detailed information about a specific attachment using its unique ID.
update_attachment
Update an attachment's details by its ID, modifying the specified attachment data.
delete_attachment
Delete an attachment by its unique ID.
list_audit_logs
Retrieve audit logs with optional filters for source, actor, IP, action, creation date, and sorting.
show_audit_log
Retrieve detailed information for a specific audit log entry using its unique ID.
export_audit_logs
Export audit logs with optional filters for source type, source ID, actor ID, IP address, creation date, and action.
autocomplete_tags
Retrieve tag suggestions matching a partial name for autocomplete functionality.
autocomplete_tags_post
Generate tag suggestions based on input name with customizable result count.
Example request and response
{
"request": {
"name": "att"
}
}list_automations
Retrieve a paginated, sortable list of automations with optional filters for active status and included related data.
create_automation
Create a new automation by providing the required automation details in the request.
show_automation
Retrieve detailed information about a specific automation using its unique automation ID.
update_automation
Update an existing automation by providing its ID and the new automation details.
delete_automation
Delete an automation by its unique ID.
list_active_automations
Retrieve a list of all currently active automations.
bulk_delete_automations
Delete multiple automations at once by specifying their IDs.
search_automations
Search automations with filters for query, status, sorting, and included fields to find specific automation workflows efficiently.
update_many_automations
Update multiple automations simultaneously by providing their details in a single request.
list_bookmarks
Retrieve a list of all saved bookmarks with no additional parameters required.
create_bookmark
Create a new bookmark by providing the bookmark details in the request.
delete_bookmark
Delete a bookmark by its unique identifier.
list_brand_agents
Retrieve a paginated, sortable list of brand agent memberships with optional page and per-page parameters.
create_brand_agent
Create a new brand agent membership by providing the required brand agent details.
show_brand_agent_by_id
Retrieve detailed information about a brand agent using their unique ID.
delete_brand_agent_by_id
Delete a brand agent membership by specifying the brand agent's unique ID.
list_brands
Retrieve a paginated, sortable list of brands with options to filter by assignable status, include deleted entries, and specify related data to include.
Example request and response
{
"response": {
"count": 2,
"brands": [
{
"id": 360002783572,
"url": "https://company.zendesk.com/api/v2/brands/360002783572",
"logo": {
"id": 928374,
"url": "https://company.zendesk.com/api/v2/attachments/928374",
"size": 166144,
"file_name": "brand1_logo.png",
"thumbnails": [
{
"id": 928375,
"url": "https://company.zendesk.com/api/v2/attachments/928375",
"size": 58298,
"file_name": "brand1_logo_thumb.png",
"content_url": "https://company.zendesk.com/photos/brand1_logo_thumb.png",
"content_type": "image/png",
"mapped_content_url": "https://company.com/photos/brand1_logo_thumb.png"
}
],
"content_url": "https://company.zendesk.com/logos/brand1_logo.png",
"content_type": "image/png",
"mapped_content_url": "https://company.com/logos/brand1_logo.png"
},
"name": "Brand 1",
"active": true,
"default": true,
"brand_url": "https://brand1.zendesk.com",
"subdomain": "brand1",
"created_at": "2019-08-06T02:43:39Z",
"is_deleted": false,
"updated_at": "2019-08-06T02:43:40Z",
"host_mapping": "brand1.com",
"has_help_center": true,
"ticket_form_ids": [
360000660811
],
"user_separation": "account",
"help_center_state": "enabled",
"signature_template": "{{agent.signature}}"
},
{
"id": 360002783573,
"url": "https://company.zendesk.com/api/v2/brands/360002783573",
"logo": {
"id": 928377,
"url": "https://company.zendesk.com/api/v2/attachments/928377",
"size": 166144,
"file_name": "brand2_logo.png",
"thumbnails": [
{
"id": 928378,
"url": "https://company.zendesk.com/api/v2/attachments/928378",
"size": 58298,
"file_name": "brand2_logo_thumb.png",
"content_url": "https://company.zendesk.com/photos/brand2_logo_thumb.png",
"content_type": "image/png",
"mapped_content_url": "https://company.com/photos/brand2_logo_thumb.png"
}
],
"content_url": "https://company.zendesk.com/logos/brand2_logo.png",
"content_type": "image/png",
"mapped_content_url": "https://company.com/logos/brand2_logo.png"
},
"name": "Brand 2",
"active": true,
"default": false,
"brand_url": "https://brand2.zendesk.com",
"subdomain": "brand2",
"created_at": "2019-09-12T10:15:00Z",
"is_deleted": false,
"updated_at": "2019-09-12T10:15:01Z",
"host_mapping": "brand2.com",
"has_help_center": false,
"ticket_form_ids": [],
"user_separation": "brand",
"help_center_state": "disabled",
"signature_template": "{{agent.signature}}"
}
],
"next_page": null,
"previous_page": null
}
}create_brand
Create a new brand by providing the brand details in the request.
Example request and response
{
"response": {
"brand": {
"id": 360002783573,
"url": "https://company.zendesk.com/api/v2/brands/360002783573",
"logo": {
"id": 928377,
"url": "https://company.zendesk.com/api/v2/attachments/928377",
"size": 166144,
"file_name": "brand2_logo.png",
"thumbnails": [
{
"id": 928378,
"url": "https://company.zendesk.com/api/v2/attachments/928378",
"size": 58298,
"file_name": "brand2_logo_thumb.png",
"content_url": "https://company.zendesk.com/photos/brand2_logo_thumb.png",
"content_type": "image/png",
"mapped_content_url": "https://company.com/photos/brand2_logo_thumb.png"
}
],
"content_url": "https://company.zendesk.com/logos/brand2_logo.png",
"content_type": "image/png",
"mapped_content_url": "https://company.com/logos/brand2_logo.png"
},
"name": "Brand 2",
"active": true,
"default": false,
"brand_url": "https://brand2.zendesk.com",
"subdomain": "brand2",
"created_at": "2019-09-12T10:15:00Z",
"is_deleted": false,
"updated_at": "2019-09-12T10:15:01Z",
"host_mapping": "brand2.com",
"has_help_center": false,
"ticket_form_ids": [],
"user_separation": "brand",
"help_center_state": "disabled",
"signature_template": "{{agent.signature}}"
}
}
}show_brand
Retrieve detailed information about a specific brand by its ID, with optional inclusion of related data.
Example request and response
{
"response": {
"brand": {
"id": 360002783573,
"url": "https://company.zendesk.com/api/v2/brands/360002783573",
"logo": {
"id": 928377,
"url": "https://company.zendesk.com/api/v2/attachments/928377",
"size": 166144,
"file_name": "brand2_logo.png",
"thumbnails": [
{
"id": 928378,
"url": "https://company.zendesk.com/api/v2/attachments/928378",
"size": 58298,
"file_name": "brand2_logo_thumb.png",
"content_url": "https://company.zendesk.com/photos/brand2_logo_thumb.png",
"content_type": "image/png",
"mapped_content_url": "https://company.com/photos/brand2_logo_thumb.png"
}
],
"content_url": "https://company.zendesk.com/logos/brand2_logo.png",
"content_type": "image/png",
"mapped_content_url": "https://company.com/logos/brand2_logo.png"
},
"name": "Brand 2",
"active": true,
"default": false,
"brand_url": "https://brand2.zendesk.com",
"subdomain": "brand2",
"created_at": "2019-09-12T10:15:00Z",
"is_deleted": false,
"updated_at": "2019-09-12T10:15:01Z",
"host_mapping": "brand2.com",
"has_help_center": true,
"ticket_form_ids": [
360000660811
],
"user_separation": "brand",
"help_center_state": "enabled",
"signature_template": "{{agent.signature}}"
}
}
}update_brand
Update a brand's details using its ID and the provided brand data.
Example request and response
{
"response": {
"brand": {
"id": 360002783573,
"url": "https://company.zendesk.com/api/v2/brands/360002783573",
"logo": {
"id": 928377,
"url": "https://company.zendesk.com/api/v2/attachments/928377",
"size": 166144,
"file_name": "brand2_logo.png",
"thumbnails": [
{
"id": 928378,
"url": "https://company.zendesk.com/api/v2/attachments/928378",
"size": 58298,
"file_name": "brand2_logo_thumb.png",
"content_url": "https://company.zendesk.com/photos/brand2_logo_thumb.png",
"content_type": "image/png",
"mapped_content_url": "https://company.com/photos/brand2_logo_thumb.png"
}
],
"content_url": "https://company.zendesk.com/logos/brand2_logo.png",
"content_type": "image/png",
"mapped_content_url": "https://company.com/logos/brand2_logo.png"
},
"name": "Brand 2",
"active": true,
"default": false,
"brand_url": "https://brand2.zendesk.com",
"subdomain": "brand2",
"created_at": "2019-09-12T10:15:00Z",
"is_deleted": false,
"updated_at": "2019-09-12T10:15:01Z",
"host_mapping": "brand2.com",
"has_help_center": true,
"ticket_form_ids": [
360000660811
],
"user_separation": "brand",
"help_center_state": "enabled",
"signature_template": "{{agent.signature}}"
}
}
}delete_brand
Delete a brand by its unique ID.
list_brand_agents_by_brand
Retrieve a list of agents associated with a specific brand using the brand's unique identifier.
check_host_mapping_validity_for_existing_brand
Verify if the host mapping is valid for a specified existing brand using its brand ID.
update_brand_logo
Update a brand's logo by uploading new image data using the brand's unique identifier.
delete_brand_logo
Delete the logo image associated with a specific brand using its brand ID.
list_brand_user_migrations
Retrieve a list of user migration records for a specific brand by providing the brand ID.
create_brand_user_migration
Create a user migration for a specific brand by providing the brand ID and migration details.
show_brand_user_migration
Retrieve details of a specific user migration for a given brand using brand and migration IDs.
update_brand_user_migration
Update a specific user migration for a brand by providing brand ID, migration ID, and updated migration details.
check_host_mapping_validity
Verify if a given host mapping and subdomain combination is valid and correctly configured.
list_monitored_twitter_handles
Retrieve a list of all Twitter handles currently being monitored.
Example request and response
{
"response": {
"monitored_twitter_handles": [
{
"id": 211,
"brand_id": 123,
"created_at": "2009-05-13T00:07:08Z",
"updated_at": "2011-07-22T00:11:12Z",
"screen_name": "@zendesk",
"twitter_user_id": 67462376832
},
{
"id": 431,
"brand_id": 456,
"created_at": "2010-05-13T22:07:08Z",
"updated_at": "2011-07-22T00:15:19Z",
"screen_name": "@zendeskops",
"twitter_user_id": 67923318930
}
]
}
}show_monitored_twitter_handle
Retrieve details of a specific monitored Twitter handle using its unique identifier.
Example request and response
{
"response": {
"monitored_twitter_handle": {
"id": 431,
"brand_id": 123,
"created_at": "2010-05-13T22:07:08Z",
"updated_at": "2011-07-22T00:15:19Z",
"screen_name": "@zendeskops",
"twitter_user_id": 67923318930
}
}
}create_ticket_from_tweet
Create a support ticket using information extracted from a tweet.
getting_twicket_status
Retrieve the status history of a ticket using its comment ID, with optional filtering by status IDs.
open_ticket_in_agent_browser
Open a specific ticket in the assigned agent's browser for immediate review and action.
open_users_profile_in_agent_browser
Open a specific user's profile in the browser interface of a designated agent using their agent and user IDs.
create_ticket_or_voicemail_ticket
Create a new voice ticket or voicemail ticket with specified agent display settings and ticket details.
list_whatsapp_templates
Retrieve a paginated list of WhatsApp message templates filtered by integration, status, category, language, and name.
toggle_whatsapp_template
Activate or deactivate a WhatsApp template by toggling its active status using the template ID.
Example request and response
{
"request": {
"is_active": true
},
"response": {
"whatsapp_template": {
"id": "01JBQ8Z5K7N3M9P2R4T6V8X0YA",
"name": "order_confirmation",
"status": "approved",
"category": "UTILITY",
"language": "en_US",
"is_active": true,
"components": [
{
"text": "Hi {{1}}, your order {{2}} has shipped.",
"type": "BODY"
}
],
"created_at": "2026-09-14T14:32:27Z",
"updated_at": "2026-09-17T17:24:25Z",
"template_id": "1234567890",
"integrations": [
{
"id": "5f3a1b2c4d5e6f7a8b9c0d1e",
"name": "WhatsApp Support"
}
]
}
}
}list_whatsapp_template_languages
Retrieve available languages for WhatsApp message templates using the specified integration ID.
toggle_many_whatsapp_templates
Activate or deactivate multiple WhatsApp message templates in bulk by specifying their IDs and desired active status.
Example request and response
{
"request": {
"is_active": false,
"template_ids": [
"1234567890",
"1234567891"
]
}
}redact_chat_comment_attachment
Redact an attachment from a chat comment by specifying the ticket ID.
Example request and response
{
"request": {
"chat_id": "2109.10502823.Sjuj2YrBpXwei",
"chat_indexes": [
0,
1
]
}
}redact_chat_comment
Redact a specific chat comment by ticket ID to remove sensitive or inappropriate content.
Example request and response
{
"request": {
"text": "My ID number is <redact>847564</redact>!",
"chat_id": "2109.10502823.Sjuj2YrBpXwei",
"chat_index": 0
}
}redact_ticket_comment_in_agent_workspace
Redact a specific ticket comment by ID, updating its content and attachments via a PUT request.
Example request and response
{
"request": {
"html_body": "<div class=\"zd-comment\" dir=\"auto\">My ID number is <redact>847564</redact>!</div>",
"ticket_id": 100
}
}list_countries
Retrieve a list of countries along with their international calling codes.
Example request and response
{
"response": {
"countries": [
{
"id": 1,
"code": "AF",
"name": "Afghanistan",
"region": "APAC",
"calling_code": "93"
},
{
"id": 2,
"code": "AL",
"name": "Albania",
"region": "EMEA",
"calling_code": "355"
}
]
}
}show_country
Retrieve detailed information about a country using its unique identifier.
Example request and response
{
"response": {
"country": {
"id": 1,
"code": "AF",
"name": "Afghanistan",
"region": "APAC",
"calling_code": "93"
}
}
}list_custom_objects
Retrieve a list of custom objects, optionally including their UI paths.
create_custom_object
Create a new custom object by providing the required object details in the request.
show_custom_object
Retrieve details of a custom object by key, with optional permissions and UI path information.
update_custom_object
Update a custom object by its key with new data using a PATCH request.
delete_custom_object
Delete a custom object by specifying its unique key.
list_access_rules
Retrieve the list of access rules for a specified custom object using its unique key.
create_access_rule
Create a new access rule for a specified custom object using its key and access rule details.
show_access_rule
Retrieve details of a specific access rule by its ID for a given custom object key.
update_access_rule
Update a specific access rule for a custom object using its key and rule ID with new access rule details.
delete_access_rule
Delete a specific access rule by its ID for the given custom object key.
list_access_rule_definitions
Retrieve all access rule definitions for a specified custom object by its key.
list_custom_object_fields
Retrieve a list of fields for a specified custom object, with an option to include standard fields.
create_custom_object_field
Create a new field in a specified custom object using the provided field details.
show_custom_object_field
Retrieve details of a specific field from a custom object, with optional inclusion of standard fields.
update_custom_object_field
Update a specific field of a custom object using its key or ID.
delete_custom_object_field
Delete a specific field from a custom object using its key or ID.
reorder_custom_object_fields
Reorder the fields of a custom object by specifying the object key and the new sequence of field IDs.
custom_object_record_bulk_jobs
Create bulk jobs to process multiple records for a specified custom object using the provided job details.
custom_object_fields_limit
Retrieve the maximum allowed number of fields for a specified custom object.
list_permission_policies
Retrieve all permission policies associated with a specific custom object by its key.
show_permission_policy
Retrieve details of a specific permission policy for a given custom object by its key and policy ID.
update_permission_policy
Update a specific permission policy for a custom object using its key and policy ID.
list_custom_object_records
Retrieve a list of records from a specified custom object with optional filtering, sorting, and pagination parameters.
create_custom_object_record
Create a new record in a specified custom object using the provided data.
upsert_custom_object_record_by_external_id_or_name
Create or update a custom object record using an external ID or name for identification.
delete_custom_object_record_by_external_id_or_name
Delete a custom object record using its external ID, name, or unique field value by specifying the custom object key.
show_custom_object_record
Retrieve a specific record from a custom object using its unique key and record ID.
update_custom_object_record
Update a specific record within a custom object using its key and record ID.
delete_custom_object_record
Delete a specific record from a custom object using its unique key and record ID.
list_custom_object_record_attachments
Retrieve all attachments linked to a specific custom object record using its key and record ID.
create_custom_object_record_attachment
Upload an attachment to a specific record within a custom object using its key and record ID.
update_custom_object_record_attachment
Update an attachment for a specific record in a custom object using its keys and attachment ID.
delete_custom_object_record_attachment
Delete a specific attachment from a custom object record using its unique keys and attachment ID.
download_custom_object_record_attachment
Download an attachment from a specific custom object record using its keys and attachment ID, with optional inline display.
autocomplete_custom_object_record_search
Autocomplete search for records in a custom object using filters, pagination, and specific fields to refine results.
count_custom_object_records
Get the total count of records for a specified custom object by its key.
Example request and response
{
"response": {
"count": {
"value": 7,
"refreshed_at": "2022-09-02T22:44:35Z"
}
}
}search_custom_object_records
Search records within a specified custom object using query, sorting, and pagination parameters.
filtered_search_custom_object_records
Search and filter records within a specified custom object using query, sorting, and pagination parameters.
show_custom_object_record_by_unique_identifier
Retrieve a custom object record using its unique identifier and specified field values.
update_custom_object_record_by_unique_identifier_via_put
Update a custom object record using its unique identifier with specified field values via PUT request.
update_custom_object_record_by_unique_identifier
Update a custom object record using a unique identifier and specified field values.
list_object_triggers
Retrieve a list of triggers for a specified custom object, with optional filters for active status and sorting preferences.
create_object_trigger
Create a trigger for a specified custom object using the provided trigger details.
get_object_trigger
Retrieve details of a specific trigger for a given custom object using its key and trigger ID.
update_object_trigger
Update a specific trigger for a custom object using its key and trigger ID.
delete_object_trigger
Delete a specific trigger associated with a custom object using its key and trigger ID.
list_active_object_triggers
Retrieve a sorted list of active triggers for a specified custom object using its key.
list_object_triggers_definitions
Retrieve definitions of trigger actions and conditions for a specified custom object.
delete_many_object_triggers
Delete multiple triggers associated with a specific custom object using its key and trigger IDs.
search_object_triggers
Retrieve and search triggers for a specified custom object using filters, query, sorting, and inclusion options.
update_many_object_triggers
Update multiple triggers for a specified custom object using the provided trigger data.
custom_objects_limit
Retrieve the current limit for custom objects allowed in the system.
custom_object_records_limit
Retrieve the maximum allowed number of records for custom objects in the system.
list_custom_roles
Retrieve a list of all custom roles available in the system.
create_custom_role
Create a new custom role with specified permissions and settings.
show_custom_role_by_id
Retrieve detailed information about a custom role using its unique identifier.
update_custom_role_by_id
Update a custom role's details using its unique identifier.
delete_custom_role_by_id
Delete a custom role by its unique ID.
bulk_update_default_custom_status
Update the default custom status for multiple tickets by providing their IDs in a single request.
list_custom_statuses
Retrieve a list of custom ticket statuses with optional filters for status categories, active state, and default status.
create_custom_status
Create a custom ticket status by providing the necessary status details.
show_custom_status
Retrieve details of a specific custom ticket status by its ID.
update_custom_status
Update a custom ticket status by specifying its ID and new status details.
delete_custom_status
Delete a custom ticket status by its unique ID.
create_ticket_form_statuses_for_custom_status
Create ticket form statuses linked to a specific custom status using its ID.
Example request and response
{
"request": {
"ticket_form_status": [
{
"ticket_form_id": 1
},
{
"ticket_form_id": 2
},
{
"ticket_form_id": 3
}
]
}
}show_many_custom_statuses
Retrieve details for multiple custom ticket statuses by specifying their IDs.
list_deleted_tickets
Retrieve a paginated list of deleted support tickets with optional sorting and filtering by support type.
delete_ticket_permanently
Permanently delete a ticket using its ticket_id.
restore_deleted_ticket
Restore a ticket that was previously deleted using its ticket ID.
bulk_permanently_delete_tickets
Permanently delete multiple tickets by specifying their IDs in a single request.
bulk_restore_deleted_tickets
Restore multiple deleted tickets at once by providing their IDs.
list_deleted_users
Retrieve a paginated, sortable list of deleted users with options to limit results and specify order.
Example request and response
{
"response": {
"deleted_users": [
{
"id": 189304711533,
"url": "https://{subdomain}.zendesk.com/api/v2/deleted_users/189304711533",
"name": "David",
"role": "end-user",
"email": "david@gmail.com",
"phone": null,
"photo": null,
"active": false,
"locale": "en-US",
"locale_id": 1,
"time_zone": "Eastern Time (US & Canada)",
"created_at": "2019-08-26T02:10:24Z",
"separation": {
"scope": "brand",
"brand_id": 123
},
"updated_at": "2019-08-26T02:10:27Z",
"organization_id": 12312312,
"shared_phone_number": null
},
{
"id": 12204720593,
"url": "https://{subdomain}.zendesk.com/api/v2/deleted_users/12204720593",
"name": "Linda",
"role": "end-user",
"email": "linda@gmail.com",
"phone": null,
"photo": null,
"active": false,
"locale": "en-US",
"locale_id": 1,
"time_zone": "Eastern Time (US & Canada)",
"created_at": "2019-08-26T02:10:28Z",
"separation": {
"scope": "brand",
"brand_id": 456
},
"updated_at": "2019-08-26T02:10:29Z",
"organization_id": 123123123,
"shared_phone_number": null
}
]
}
}show_deleted_user
Retrieve detailed information about a specific deleted user by their user ID.
Example request and response
{
"response": {
"deleted_user": {
"id": 189304711533,
"url": "https://{subdomain}.zendesk.com/api/v2/deleted_users/189304711533",
"name": "David",
"role": "end-user",
"email": "david@email.com",
"phone": null,
"photo": null,
"active": false,
"locale": "en-US",
"locale_id": 1,
"time_zone": "Eastern Time (US & Canada)",
"created_at": "2019-08-26T02:10:24Z",
"separation": {
"scope": "brand",
"brand_id": 123
},
"updated_at": "2019-08-26T02:10:27Z",
"organization_id": 360000000008,
"shared_phone_number": null
}
}
}permanently_delete_user
Permanently delete a user by their deleted user ID.
Example request and response
{
"response": {
"deleted_user": {
"id": 189304711533,
"url": "https://{subdomain}.zendesk.com/api/v2/deleted_users/189304711533",
"name": "David",
"role": "end-user",
"email": "david@email.com",
"phone": null,
"photo": null,
"active": false,
"locale": "en-US",
"locale_id": 1,
"time_zone": "Eastern Time (US & Canada)",
"created_at": "2019-08-26T02:10:24Z",
"separation": {
"scope": "brand",
"brand_id": 123
},
"updated_at": "2019-08-26T02:10:27Z",
"organization_id": 360000000008,
"shared_phone_number": null
}
}
}count_deleted_users
Retrieve the total number of deleted users in the system.
list_deletion_schedules
Retrieve a list of all scheduled data deletions with their details.
create_deletion_schedule
Create a new deletion schedule by providing the required schedule details.
get_deletion_schedule
Retrieve details of a specific deletion schedule using its unique ID.
update_deletion_schedule
Update a deletion schedule by ID with new schedule details.
delete_deletion_schedule
Delete a specific deletion schedule by its ID.
list_dynamic_contents
Retrieve a paginated, sortable list of dynamic content items with optional page, per_page, and sort parameters.
create_dynamic_content
Create a new dynamic content item by providing the item details in the request.
show_dynamic_content_item
Retrieve detailed information about a specific dynamic content item using its unique identifier.
update_dynamic_content_item
Update a dynamic content item by its ID with new item data via a PUT request.
delete_dynamic_content_item
Delete a dynamic content item by its unique ID.
dynamic_content_list_variants
Retrieve a paginated, sortable list of variants for a specific dynamic content item by its ID.
create_dynamic_content_variant
Create a new variant for a specific dynamic content item using its ID and variant details.
show_dynamic_content_variant
Retrieve details of a specific variant for a given dynamic content item by its IDs.
update_dynamic_content_variant
Update a specific variant of dynamic content by providing its item ID, variant ID, and updated variant data.
delete_dynamic_content_variant
Delete a specific variant of a dynamic content item using its item and variant IDs.
create_many_dynamic_content_variants
Create multiple variants for a specific dynamic content item by providing its ID and variant details in a single request.
update_many_dynamic_content_variants
Update multiple variants of a dynamic content item by providing the item ID and variant details.
show_many_dynamic_contents
Retrieve multiple dynamic content items by their identifiers in a single request.
list_email_notifications
Retrieve a list of email notifications with optional filtering, sorting, and pagination parameters.
show_email_notification
Retrieve detailed information about a specific email notification using its unique notification ID.
show_many_email_notifications
Retrieve multiple email notifications by specifying their IDs, comment IDs, or ticket IDs.
list_end_user_identities
Retrieve a list of identities for a specific end user, with optional filtering by identity type.
create_end_user_identity
Create a new identity for a specified end user by providing user ID, identity type(s), brand ID, and identity details.
show_end_user_identity
Retrieve detailed information about a specific identity linked to an end user by user and identity IDs.
delete_end_user_identity
Delete a specific identity linked to an end user by providing the user and identity IDs.
make_end_user_identity_primary
Set a specific user identity as the primary identity for the given end user.
request_end_user_verification
Initiate a verification request for a specific end user's identity using their user and identity IDs.
list_group_memberships
Retrieve a paginated, sortable list of group memberships with optional related data included.
create_group_membership
Create a new membership by adding a user to a specified group.
show_group_membership_by_id
Retrieve details of a group membership by its unique ID.
delete_group_membership
Delete a group membership by its unique ID.
list_assignable_group_memberships
Retrieve a list of group memberships available for assignment.
group_membership_bulk_create
Create multiple group memberships in bulk by providing a list of membership details in a single request.
group_membership_bulk_delete
Delete multiple group memberships at once by specifying their IDs.
list_group_slapolicies
Retrieve a list of all group SLA policies with their details.
create_group_slapolicy
Create a new group SLA policy with specified settings via a POST request.
show_group_slapolicy
Retrieve detailed information about a specific group SLA policy using its unique identifier.
update_group_slapolicy
Update a specific Group SLA Policy using its ID and new policy details.
delete_group_slapolicy
Delete a specific Group SLA Policy by its ID.
retrieve_group_slapolicy_filter_definition_items
Get a list of supported filter definition items for service level agreement policies.
reorder_group_slapolicies
Reorder SLA policies within a group by specifying the new sequence of policy IDs.
list_groups
Retrieve a paginated list of groups with options to exclude deleted, include related data, sort, and add boundary indicators or item cursors.
create_group
Create a new group by providing the group details in the request body.
show_group_by_id
Retrieve detailed information about a group by its ID, with optional inclusion of related data.
update_group
Update a group's details by specifying its ID and the new group data.
delete_group
Delete a group by specifying its unique group ID.
list_group_memberships_by_group
Retrieve a list of all memberships within a specified group using the group ID.
list_assignable_group_memberships_by_group
Retrieve all assignable memberships within a specified group by providing the group ID.
list_group_users
Retrieve users in a group with optional filters for role, permission set, and external ID.
count_group_users
Get the count of users in a group, optionally filtered by role(s) or permission set.
list_assignable_groups
Retrieve a list of groups available for assignment.
autocomplete_groups
Fetch group name suggestions matching a partial input for autocomplete functionality.
list_available_agents
Retrieve a paginated, sortable list of available agents with optional boundary indicators and item cursors for navigation.
count_groups
Retrieve the total number of groups available. No parameters required.
show_default_group
Retrieve details of the default user group with no additional parameters required.
ticket_import
Import tickets by uploading data with options to archive immediately. Supports batch ticket creation and updates via POST request.
Example request and response
{
"request": {
"ticket": {
"tags": [
"foo",
"bar"
],
"subject": "Help",
"brand_id": 123,
"comments": [
{
"value": "This is a comment",
"author_id": 827,
"created_at": "2009-06-25T10:15:18Z"
},
{
"value": "This is a private comment",
"public": false,
"author_id": 19
}
],
"assignee_id": 19,
"description": "A description",
"requester_id": 827
}
},
"response": {
"ticket": {
"id": 35436,
"url": "https://company.zendesk.com/api/v2/tickets/35436",
"via": {
"channel": "web"
},
"tags": [
"enterprise",
"other_tag"
],
"type": "incident",
"due_at": null,
"status": "open",
"subject": "Help, my printer is on fire!",
"brand_id": 123,
"group_id": 98738,
"priority": "high",
"recipient": "support@company.com",
"created_at": "2009-07-20T22:55:29Z",
"problem_id": 9873764,
"updated_at": "2011-05-05T10:38:52Z",
"assignee_id": 235323,
"description": "The fire is very colorful.",
"external_id": "ahg35h3jh",
"raw_subject": "{{dc.printer_on_fire}}",
"follower_ids": [
35334,
234
],
"requester_id": 20978392,
"submitter_id": 76872,
"custom_fields": [
{
"id": 27642,
"value": "745"
},
{
"id": 27648,
"value": "yes"
}
],
"has_incidents": false,
"organization_id": 509974,
"collaborator_ids": [
35334,
234
],
"custom_status_id": 123,
"generated_timestamp": 1304553600,
"satisfaction_rating": {
"id": 1234,
"score": "good",
"comment": "Great support!"
},
"sharing_agreement_ids": [
84432
],
"from_messaging_channel": false
}
}
}ticket_bulk_import
Import multiple tickets at once by uploading ticket data and optionally archiving them immediately.
Example request and response
{
"request": {
"tickets": [
{
"tags": [
"foo",
"bar"
],
"subject": "Help",
"brand_id": 123,
"comments": [
{
"value": "This is a comment",
"author_id": 827,
"created_at": "2009-06-25T10:15:18Z"
},
{
"value": "This is a private comment",
"public": false,
"author_id": 19
}
],
"assignee_id": 19,
"description": "A description",
"requester_id": 827
},
{
"tags": [
"foo",
"bar"
],
"subject": "Missing Item",
"brand_id": 123,
"comments": [
{
"value": "This is a comment",
"author_id": 830,
"created_at": "2009-06-25T10:15:18Z"
},
{
"value": "This is a private comment",
"public": false,
"author_id": 21
}
],
"assignee_id": 21,
"description": "A description",
"requester_id": 830
}
]
}
}incremental_sample_export
Retrieve a sample of data changes for a specified resource starting from a given time.
incremental_custom_object_record_export_cursor
Retrieve a cursor for incremental export of custom object records with optional filters, pagination, and start time parameters.
incremental_organization_export
Retrieve organizations updated since a specified time with pagination support.
incremental_skil_based_routing_attribute_values_export
Retrieve incremental updates of routing attribute values for efficient data synchronization.
incremental_skil_based_routing_attributes_export
Retrieve incremental updates of routing attributes for skill-based routing configurations.
incremental_skil_based_routing_instance_values_export
Retrieve incremental export of routing instance values with no parameters required.
incremental_ticket_events
Retrieve ticket events incrementally with optional filters for start time, support type, and included data fields.
list_ticket_metric_events
Retrieve ticket metric events with optional filters for start time, changes, deletions, and pagination.
incremental_ticket_export_time
Retrieve tickets updated since a specific time, filtered by support type.
incremental_ticket_export_cursor
Retrieve a cursor for incremental ticket export using start time, cursor, and support type scope filters.
incremental_user_export_time
Retrieve users updated since a specific time, with pagination support.
incremental_user_export_cursor
Retrieve a paginated list of users updated since a specific time using cursor-based pagination. Parameters: start_time, cursor, per_page.
list_itam_asset_types
Retrieve a list of all available IT asset types.
create_itam_asset_type
Create a new asset type by providing the asset type details.
show_itam_asset_type
Retrieve detailed information about a specific asset type using its unique identifier.
update_itam_asset_type
Update an asset type's details by specifying its ID and the new asset type information.
delete_itam_asset_type
Delete an asset type by its unique ID.
list_itam_asset_type_fields
Retrieve all fields associated with a specific asset type by providing its asset_type_id.
show_itam_asset_type_field
Retrieve details of a specific field for a given asset type by providing the asset type ID and field ID.
list_itam_assets
Retrieve a paginated list of IT assets, optionally filtered by asset IDs or external IDs.
create_itam_asset
Create a new IT asset by providing the asset details in the request.
show_itam_asset
Retrieve detailed information about a specific IT asset using its unique asset ID.
update_itam_asset
Update an asset's details using its ID and provided asset data.
delete_itam_asset
Delete an IT asset by its unique asset ID.
itam_asset_bulk_jobs
Create and manage bulk asset jobs by submitting job details for processing multiple IT assets simultaneously.
search_itam_assets
Search and retrieve IT assets using query filters, sorting, and pagination options.
filtered_search_itam_assets
Search and filter IT assets with customizable queries, sorting, and pagination options for precise asset retrieval.
list_itam_fields
Retrieve a paginated list of available fields for IT asset management records.
create_itam_field
Create a custom field for specified asset types by providing asset type IDs and field details.
show_itam_field
Retrieve detailed information about a specific asset management field by its ID.
update_itam_field
Update a specific asset field by ID, modifying its details and associated asset types.
delete_itam_field
Delete a specific asset management field by its ID.
list_itam_locations
Retrieve a paginated list of asset locations with optional page parameter for navigation.
create_itam_location
Create a new asset location by providing the location details.
show_itam_location
Retrieve detailed information about a specific asset location using its location ID.
update_itam_location
Update the details of a specific asset location using its ID and new location information.
delete_itam_location
Delete an asset location by its unique location ID.
list_itam_statuses
Retrieve a list of all available asset statuses for IT asset management.
create_itam_status
Create a new asset status by providing the status name.
show_itam_status
Retrieve detailed information about a specific asset status using its unique status ID.
update_itam_status
Update the status of an asset by specifying its status ID and new status value.
delete_itam_status
Delete an asset status by its unique ID.
list_job_statuses
Retrieve a paginated list of job statuses with optional page parameter for navigation.
show_job_status
Retrieve detailed status information for a specific job using its unique job_status_id.
show_many_job_statuses
Retrieve the statuses of multiple jobs by providing their IDs in a single request.
list_locales
Retrieve a list of all available locales with their details.
show_locale_by_id
Retrieve detailed information about a specific locale using its unique locale ID.
list_locales_for_agent
Retrieve a list of available locales supported by the agent.
show_current_locale
Retrieve the current locale setting of the user or system.
detect_best_locale
Detect the most suitable language locale for the user based on their preferences or settings.
list_available_public_locales
Retrieve a list of all publicly available locales without requiring any parameters.
list_macros
Retrieve a filtered and sorted list of macros with options for inclusion, access level, status, category, group, and view permissions.
create_macro
Create a new macro by providing the macro details in the request body.
Example request and response
{
"request": {
"macro": {
"title": "Roger Wilco",
"actions": [
{
"field": "status",
"value": "solved"
}
]
}
}
}show_macro
Retrieve detailed information about a specific macro using its unique identifier.
update_macro
Update a macro's details using its ID and new macro data.
Example request and response
{
"request": {
"macro": {
"title": "Sets the ticket status to `solved`",
"actions": [
{
"field": "status",
"value": "solved"
}
]
}
}
}delete_macro
Delete a macro by its unique ID.
show_changes_to_ticket
Retrieve and display the changes applied to a ticket by executing a specified macro, with optional comment normalization.
list_macro_attachments
Retrieve a list of attachments associated with a specific macro using its ID.
create_associated_macro_attachment
Attach a file to a specific macro by providing the macro ID and attachment details.
list_macros_actions
Retrieve a list of all supported actions available for macros.
list_active_macros
Retrieve a paginated list of active macros with optional filters for category, group, access, and sorting preferences.
create_macro_attachment
Create a new macro attachment not linked to any existing macro.
show_macro_attachment
Retrieve details of a specific macro attachment using its attachment ID.
download_macro_attachment
Download the content of a macro attachment by its unique attachment ID.
list_macro_categories
Retrieve a list of all available macro categories.
list_macro_action_definitions
Retrieve a list of all available macro action definitions with their details.
delete_many_macros
Delete multiple macros at once by providing their IDs in a single request.
list_macro_groups
Retrieve a paginated list of macro groups with optional page and per_page parameters for navigation.
list_most_used_macros
Retrieve a list of the most frequently used macros.
show_derived_macro
Retrieve a derived macro replica using macro_id and ticket_id for reference.
search_macro
Search and filter macros by category, access, status, group, and sorting options to find specific automation scripts quickly.
update_many_macros
Update multiple macros simultaneously by providing their details in a single request.
Example request and response
{
"request": {
"macros": [
{
"id": 25,
"active": false
},
{
"id": 23,
"position": 5
}
]
}
}list_oauth_clients
Retrieve a paginated and sorted list of OAuth clients.
create_oauth_client
Create a new OAuth client by submitting a POST request to register client credentials and settings.
show_client
Retrieve detailed information about a specific OAuth client using its unique client ID.
update_client
Update an existing OAuth client using its unique client ID.
delete_client
Delete an OAuth client by its unique client ID.
client_generate_secret
Generate a new secret key for the specified OAuth client by its ID.
list_global_oauth_clients
Retrieve a paginated, sorted list of all global OAuth clients.
show_global_client
Retrieve details of a global OAuth client by its unique ID.
global_oauth_clients_token_summary
Retrieve a summary of active and expired tokens for specified global OAuth clients.
list_oauth_tokens
Retrieve a paginated list of OAuth tokens with optional filters for client ID, global client ID, and sorting.
show_token
Retrieve detailed information about a specific OAuth token using its unique token ID.
revoke_oauth_token
Revoke a specific OAuth token by its ID to invalidate access and prevent further use.
show_current_token
Retrieve details of the currently active OAuth token.
revoke_current_oauth_token
Revoke the OAuth token currently in use to immediately invalidate access.
revoke_many_oauth_tokens
Revoke multiple OAuth tokens by providing their token IDs in a single request.
list_organization_fields
Retrieve a paginated list of organization fields with optional data center resolution.
create_organization_field
Create a new custom field for an organization by providing the field details.
show_organization_field
Retrieve details of a specific organization field by its ID.
update_organization_field
Update a specific organization field by its ID with new field data.
delete_organization_field
Delete a specific organization field using its unique identifier.
reorder_organization_field
Reorder organization fields by updating their sequence using a list of field IDs.
list_organization_memberships
Retrieve a paginated, sortable list of organization memberships with optional related data included.
create_organization_membership
Create a new membership by adding a user to an organization with specified membership details.
show_organization_membership_by_id
Retrieve detailed information about a specific organization membership using its unique ID.
delete_organization_membership
Delete an organization membership by its ID.
create_many_organization_memberships
Create multiple organization memberships in a single request by providing membership details.
delete_many_organization_memberships
Delete multiple organization memberships in bulk by specifying their IDs.
show_organization_merge
Retrieve details of a specific organization merge by its ID.
list_organization_subscriptions
Retrieve a list of all subscriptions associated with the organization.
create_organization_subscription
Create a new subscription for an organization with the specified subscription details.
show_organization_subscription
Retrieve detailed information about a specific organization subscription using its unique ID.
delete_organization_subscription
Delete an organization subscription by its ID.
list_organizations
Retrieve a paginated, sortable list of organizations with options to include boundary indicators and item cursors for navigation.
create_organization
Create a new organization by providing the required organization details.
show_organization
Retrieve detailed information about an organization by its ID, with optional inclusion of boundary indicators and item cursors.
update_organization
Update an organization's details by providing its ID and the new organization data.
delete_organization
Delete an organization by its unique ID.
create_organization_merge
Merge an organization with another by specifying the target organization ID and merge details.
list_organization_merges
Retrieve a list of merge records for a specific organization by its ID.
list_organization_memberships_by_organization
Retrieve all memberships associated with a specific organization using its organization ID.
organization_related
Retrieve related information for a specific organization by its ID.
list_organization_requests
Retrieve a sorted list of requests for a specific organization using its ID.
list_organization_subscriptions_by_organization
Retrieve all subscriptions associated with a specific organization using its organization ID.
list_organization_tags
Retrieve all tags associated with a specific organization using its organization ID.
set_organization_tags
Add or update tags for a specific organization using its ID.
add_organization_tags
Add or update tags for a specific organization using its ID, with options for safe updates and tracking via timestamps and source.
remove_organization_tags
Delete all tags associated with a specific organization using its organization ID.
list_organization_tickets
Retrieve all tickets associated with a specific organization using its organization ID.
count_organization_tickets
Get the total number of tickets associated with a specific organization by providing its organization ID.
Example request and response
{
"response": {
"count": {
"value": 102,
"refreshed_at": "2020-04-06T02:18:17Z"
}
}
}list_organization_users
Retrieve a paginated list of users in an organization with optional filters for roles, permissions, external ID, and sorting.
count_organization_users
Get the count of users in an organization, optionally filtered by role(s) or permission set.
autocomplete_organizations
Fetch organization name suggestions with optional filters like field, source, and inclusion of boundary indicators or cursors.
count_organizations
Get the total number of organizations, with options to include boundary indicators and item cursors for detailed counting.
create_many_organizations
Create multiple organizations in a single request by providing their details in bulk.
create_or_update_organization
Create a new organization or update an existing organization's details with the provided information.
delete_many_organizations
Delete multiple organizations in bulk by specifying their IDs or external IDs.
search_organizations
Search organizations by external ID or name to find matching records.
show_many_organizations
Retrieve details for multiple organizations by specifying their IDs or external IDs.
update_many_organizations
Update multiple organizations by specifying their IDs or external IDs with new data.
list_ticket_problems
Retrieve a paginated, sortable list of ticket problems with options to include boundary indicators and item cursors for navigation.
autocomplete_problems
Suggest problem titles based on partial text input for quick and accurate problem search.
Example request and response
{
"request": {
"text": "fire"
}
}push_notification_devices
Unregister multiple push notification devices in bulk by providing their identifiers.
list_queues
Retrieve a list of all available queues with their details.
create_queue
Create a new queue by providing the queue details in the request.
show_queue_by_id
Retrieve detailed information about a specific queue using its unique queue_id.
update_queue
Update the details of a specific queue using its ID and new queue data.
delete_queue
Delete a queue by its unique identifier.
list_queue_definitions
Retrieve a list of all queue definitions with their details.
reorder_queues
Update the order of queues by providing a list of queue IDs in the desired sequence.
list_support_addresses
Retrieve a paginated, sortable list of support recipient addresses with optional related data included.
create_support_address
Create a new support address for receiving recipient communications.
show_support_address
Retrieve detailed information for a specific support address using its unique ID.
update_support_address
Update a specific support address using its ID.
delete_recipient_address
Delete a recipient address by its unique ID.
verify_support_address_forwarding
Verify and update the forwarding status of a specified support address by its ID.
get_relationship_filter_definitions
Retrieve filter definitions for relationships based on the specified target and optional source types.
list_remote_authentications
Retrieve a list of remote authentications filtered by brand ID.
list_requests
Retrieve a paginated list of requests with optional sorting and filtering by status.
create_request
Create a new request by submitting the required request details via a POST call.
show_request
Retrieve detailed information about a specific request using its unique request ID.
update_request
Update an existing request by providing the request ID and updated request details.
list_comments
Retrieve comments for a specific request, with optional filters by date and user role.
show_comment
Retrieve a specific comment by its ID from a request using the request and comment identifiers.
list_ccdrequests
Retrieve a sorted list of CCD requests with optional sorting parameters.
list_open_requests
Retrieve a list of open requests with optional sorting by specified fields and order.
search_requests
Search requests using a query parameter to find relevant entries matching the specified criteria.
list_solved_requests
Retrieve a list of solved requests with optional sorting by specified fields and order.
list_resource_collections
Retrieve a paginated list of resource collections with an optional per-page limit.
create_resource_collection
Create a new resource collection by sending a POST request without parameters.
retrieve_resource_collection
Retrieve detailed information about a specific resource collection using its unique identifier.
update_resource_collection
Update a resource collection by its ID with new data via a PUT request.
delete_resource_collection
Delete a specific resource collection by its ID.
list_agent_attribute_values
Retrieve all attribute values for a specific agent by their user ID.
set_agent_attribute_values
Update attribute values for a specific agent using their user ID and a list of attribute value IDs.
list_many_agents_attribute_values
Retrieve attribute values for multiple agents with optional filtering and pagination.
bulk_set_agent_attribute_values_job
Create a job to bulk update attribute values for multiple routing agents in a single request.
list_account_attributes
Retrieve a list of account attributes with optional filters to customize the included data.
create_attribute
Create a new routing attribute by sending a POST request with the attribute details.
show_attribute
Retrieve detailed information about a specific attribute using its unique identifier.
update_attribute
Update a routing attribute by its ID with new data via a PUT request.
delete_attribute
Delete a routing attribute by its unique attribute_id.
list_attribute_values
Retrieve all values associated with a specific attribute using its ID.
create_attribute_value
Create a new value for a specific attribute by providing the attribute ID and value details.
show_attribute_value
Retrieve details of a specific attribute value using its attribute ID and value ID.
update_attribute_value_put
Update a specific attribute value by its ID using the attribute and value identifiers.
update_attribute_value
Update a specific attribute value by its ID using the attribute and value identifiers.
delete_attribute_value
Delete a specific value from an attribute using its attribute and value IDs.
list_routing_attribute_definitions
Retrieve a list of all routing attribute definitions available for configuring routing rules.
list_tickets_fullfilled_by_user
Retrieve a list of tickets fulfilled by a user, filtered by specified ticket IDs.
list_ticket_attribute_values
Retrieve all attribute values for a specific ticket by its ID.
set_ticket_attribute_values
Set specific attribute values for a ticket by providing the ticket ID and attribute value IDs.
list_satisfaction_ratings
Retrieve a paginated and sortable list of customer satisfaction ratings.
show_satisfaction_rating
Retrieve detailed information for a specific satisfaction rating using its unique ID.
count_satisfaction_ratings
Retrieve the total number of satisfaction ratings submitted.
list_satisfaction_rating_reasons
Retrieve a list of reasons users provide for their satisfaction ratings.
show_satisfaction_ratings
Retrieve detailed information about a specific satisfaction rating reason using its unique ID.
list_saved_searches
Retrieve a list of all saved searches for the current user.
create_saved_search
Create a saved search with specified filters, name, query, and type to quickly access customized search results.
update_saved_search
Update a saved search by modifying its name, query, filters, or type using the search's unique ID.
delete_saved_search
Delete a saved search by its unique ID.
list_search_results
Retrieve a list of search results filtered by query, sorting, brand, and inclusion criteria.
count_search_results
Get the total number of search results matching a query and optional brand ID filter.
export_search_results
Export search results with filters, pagination, and included related data in a downloadable format.
show_security_settings
Retrieve the security settings for a specified brand using its brand ID.
list_sessions
Retrieve a paginated and sorted list of active sessions.
list_sharing_agreements
Retrieve a list of all sharing agreements with their details.
create_sharing_agreement
Create a new sharing agreement by providing the necessary agreement details.
show_sharing_agreement
Retrieve details of a specific sharing agreement by its ID.
update_sharing_agreement
Update details of a specific sharing agreement using its ID and the new agreement data.
delete_sharing_agreement
Delete a sharing agreement by its unique ID.
list_skips
Retrieve a sorted list of all skip entries with optional sort order.
record_new_skip
Create a new skip entry with specified sort order and skip details for the current user.
list_slapolicies
Retrieve a list of all SLA policies with their details.
create_slapolicy
Create a new SLA policy by providing the required policy details.
show_slapolicy
Retrieve detailed information about a specific SLA policy using its unique identifier.
update_slapolicy
Update an SLA policy by ID with new configuration details.
delete_slapolicy
Delete an SLA policy by its unique ID.
retrieve_slapolicy_filter_definition_items
Get a list of supported filter definition items for service level agreement policies.
reorder_slapolicies
Reorder SLA policies by specifying a new sequence of their IDs.
list_suspended_tickets
Retrieve a paginated list of suspended tickets with optional sorting by specified fields and order.
show_suspended_tickets
Retrieve detailed information about a suspended ticket using its unique ID.
delete_suspended_ticket
Delete a suspended ticket by its ID.
recover_suspended_ticket
Restore access to a suspended ticket by its ID to resume processing or updates.
suspended_tickets_attachments
Upload attachments to suspended support tickets via a POST request.
bulk_recover_suspended_tickets
Restore multiple suspended tickets at once by providing their IDs and the author responsible for the recovery.
Example request and response
{
"request": {
"author": {
"id": 12345,
"email": "user@example.com"
}
},
"response": {
"job_status": {
"id": "8b726e606741012ffc2d782bcb7848fe",
"url": "https://example.zendesk.com/api/v2/job_statuses/8b726e606741012ffc2d782bcb7848fe.json",
"total": 3,
"status": "queued",
"message": null,
"results": null,
"progress": 0
}
}
}delete_suspended_tickets
Delete multiple suspended tickets by specifying their IDs.
export_suspended_tickets
Export a list of suspended support tickets in a downloadable format via a POST request.
recover_suspended_tickets
Restore multiple suspended tickets by providing their IDs in a single request.
list_tags
Retrieve a paginated, sortable list of tags with optional page and per-page parameters.
count_tags
Retrieve the total number of tags available in the system.
list_target_failures
Retrieve a list of all target failure records with details.
show_target_failure
Retrieve detailed information about a specific target failure using its unique identifier.
list_targets
Retrieve a list of all available targets with their details.
create_target
Create a new target by sending a POST request without parameters.
show_target
Retrieve detailed information about a specific target using its unique target_id.
update_target
Update the details of a specific target using its unique ID.
delete_target
Delete a target by specifying its unique target ID.
list_task_list_templates
Retrieve a list of all available task list templates.
create_task_list_template
Create a new task list template by providing the template details.
show_task_list_template
Retrieve detailed information about a specific task list template using its unique ID.
update_task_list_template
Update a task list template by ID with new template details.
delete_task_list_template
Delete a task list template by its ID.
get_tasks_by_task_list_template_id
Retrieve all tasks associated with a specific task list template using its unique ID.
show_task_list_instance
Retrieve detailed information about a specific task list using its unique task_list_id.
update_custom_task_list
Update a custom task list by its ID with new task list details.
delete_task_list
Delete a task list by its ID.
list_task_items
Retrieve all task items within a specified task list using its unique ID.
create_custom_task_item
Create a custom task item in a specified task list by providing the task list ID and task item details.
show_task_item
Retrieve details of a specific task item within a given task list using task list and task item IDs.
update_task_item
Update a specific task item within a task list using its IDs and new task item data.
delete_custom_task_item
Delete a specific task item from a given task list using its IDs.
list_ticket_audits
Retrieve a paginated list of all ticket audit records with optional cursor-based navigation and page size control.
list_ticket_content_pins
Retrieve all pinned content items associated with a specific ticket using its ticket ID.
create_ticket_content_pin
Create a pin for specific ticket content by providing the necessary details.
Example request and response
{
"request": {
"ticket_content_pin": {
"locale": "en-US",
"ticket_id": "12345",
"content_id": "01HFS51MMTVW7CMVEV5V51NYV5",
"content_type": "article"
}
}
}delete_ticket_content_pin
Delete a specific content pin from a ticket using its unique content_pin_id.
list_ticket_fields
Retrieve a list of ticket fields with optional filters for locale, creator, system fields, activity, sorting, and pagination.
create_ticket_field
Create a new custom field for support tickets by specifying its properties.
show_ticketfield
Retrieve detailed information about a specific ticket field using its ID.
update_ticket_field
Update a specific ticket field by ID with new creator and field details via a PUT request.
delete_ticket_field
Delete a ticket field by its ID, optionally specifying the creator.
list_ticket_field_options
Retrieve all available options for a specific ticket field by providing its ID.
create_or_update_ticket_field_option
Create or update an option for a specific ticket field using its ID.
show_ticket_field_option
Retrieve details of a specific option within a ticket field using its field and option IDs.
delete_ticket_field_option
Delete a specific option from a ticket field using its ticket field ID and option ID.
count_ticket_fields
Retrieve the total number of ticket fields available in the system.
reorder_ticket_fields
Reorder the sequence of ticket fields by updating their order. No parameters required.
show_many_ticket_fields
Retrieve multiple ticket fields by IDs or keys, with options to filter by creator and exclude sub-selection options.
list_ticket_form_statuses
Retrieve a list of statuses for a specific ticket form, with optional filtering by status attributes.
show_many_ticket_form_statuses
Retrieve details for multiple ticket form statuses by providing their IDs.
list_ticket_forms
Retrieve a list of ticket forms with optional filters for status, visibility, type, brand association, pagination, and sorting.
create_ticket_form
Create a new ticket form by submitting the required form details.
show_ticket_form
Retrieve detailed information about a specific ticket form using its unique ID.
update_ticket_form
Update a ticket form by its ID with new form details using the provided ticket_form data.
delete_ticket_form
Delete a ticket form by its ID.
clone_ticket_form
Create a copy of an existing ticket form by specifying its ID and optionally adding a prefix to the cloned form's title.
ticket_form_ticket_form_statuses
Retrieve the list of statuses associated with a specific ticket form by its ID.
create_ticket_form_statuses
Create a new status for a specific ticket form by providing the form ID and status details.
Example request and response
{
"request": {
"ticket_form_status": [
{
"custom_status_id": 1234
},
{
"custom_status_id": 1235
}
]
}
}update_ticket_form_statuses
Update multiple statuses for a specific ticket form by providing the form ID and new status details in bulk.
Example request and response
{
"request": {
"ticket_form_status": [
{
"id": "abcdef",
"_destroy": "1"
},
{
"custom_status_id": 1
}
]
}
}delete_ticket_form_statuses
Delete specific statuses from a ticket form using the ticket form ID and status ID.
Example request and response
{
"request": {
"id": [
"abc",
"def",
"hij"
]
}
}update_ticket_form_status_by_id
Update the status of a specific ticket form by its ID using the provided status details.
Example request and response
{
"request": {
"ticket_form_status": {
"custom_status_id": 1
}
}
}delete_ticket_form_status_by_id
Delete a specific status from a ticket form using the ticket form ID and status ID.
reorder_ticket_forms
Reorder ticket forms by updating their sequence using a list of ticket form IDs.
show_many_ticket_forms
Retrieve multiple ticket forms by IDs with options to filter by status, visibility, brand association, and include pagination or boundary details.
list_ticket_metrics
Retrieve a paginated and sorted list of ticket metrics to analyze support performance and response times.
show_ticket_metrics
Retrieve detailed metrics for a specific ticket using its unique ticket_metric_id.
list_tickets
Retrieve a paginated list of support tickets with optional filters, sorting, and inclusion of related data.
Example request and response
{
"response": {
"tickets": [
{
"id": 35436,
"url": "https://company.zendesk.com/api/v2/tickets/35436",
"via": {
"channel": "web"
},
"tags": [
"enterprise",
"other_tag"
],
"type": "incident",
"due_at": null,
"status": "open",
"subject": "Help, my printer is on fire!",
"brand_id": 123,
"group_id": 98738,
"priority": "high",
"recipient": "support@company.com",
"created_at": "2009-07-20T22:55:29Z",
"problem_id": 9873764,
"updated_at": "2011-05-05T10:38:52Z",
"assignee_id": 235323,
"description": "The fire is very colorful.",
"external_id": "ahg35h3jh",
"raw_subject": "{{dc.printer_on_fire}}",
"follower_ids": [
35334,
234
],
"requester_id": 20978392,
"submitter_id": 76872,
"custom_fields": [
{
"id": 27642,
"value": "745"
},
{
"id": 27648,
"value": "yes"
}
],
"has_incidents": false,
"organization_id": 509974,
"collaborator_ids": [
35334,
234
],
"custom_status_id": 123,
"generated_timestamp": 1304553600,
"satisfaction_rating": {
"id": 1234,
"score": "good",
"comment": "Great support!"
},
"sharing_agreement_ids": [
84432
],
"from_messaging_channel": false
}
]
}
}create_ticket
Create a new support ticket with optional details and metadata via POST request.
Example request and response
{
"request": {
"ticket": {
"comment": {
"body": "The smoke is very colorful."
},
"subject": "My printer is on fire!",
"brand_id": 123,
"priority": "urgent"
}
},
"response": {
"ticket": {
"id": 35436,
"url": "https://company.zendesk.com/api/v2/tickets/35436",
"via": {
"channel": "web"
},
"tags": [
"enterprise",
"other_tag"
],
"type": "incident",
"due_at": null,
"status": "open",
"subject": "Help, my printer is on fire!",
"brand_id": 123,
"group_id": 98738,
"priority": "high",
"recipient": "support@company.com",
"created_at": "2009-07-20T22:55:29Z",
"problem_id": 9873764,
"updated_at": "2011-05-05T10:38:52Z",
"assignee_id": 235323,
"description": "The fire is very colorful.",
"external_id": "ahg35h3jh",
"raw_subject": "{{dc.printer_on_fire}}",
"follower_ids": [
35334,
234
],
"requester_id": 20978392,
"submitter_id": 76872,
"custom_fields": [
{
"id": 27642,
"value": "745"
},
{
"id": 27648,
"value": "yes"
}
],
"has_incidents": false,
"organization_id": 509974,
"collaborator_ids": [
35334,
234
],
"custom_status_id": 123,
"generated_timestamp": 1304553600,
"satisfaction_rating": {
"id": 1234,
"score": "good",
"comment": "Great support!"
},
"sharing_agreement_ids": [
84432
],
"from_messaging_channel": false
}
}
}show_ticket
Retrieve detailed information for a specific ticket by ID, with options to include extra data, reduce payload size, and remove duplicate fields.
Example request and response
{
"response": {
"ticket": {
"id": 35436,
"url": "https://company.zendesk.com/api/v2/tickets/35436",
"via": {
"channel": "web"
},
"tags": [
"enterprise",
"other_tag"
],
"type": "incident",
"due_at": null,
"status": "open",
"subject": "Help, my printer is on fire!",
"brand_id": 123,
"group_id": 98738,
"priority": "high",
"recipient": "support@company.com",
"created_at": "2009-07-20T22:55:29Z",
"problem_id": 9873764,
"updated_at": "2011-05-05T10:38:52Z",
"assignee_id": 235323,
"description": "The fire is very colorful.",
"external_id": "ahg35h3jh",
"raw_subject": "{{dc.printer_on_fire}}",
"follower_ids": [
35334,
234
],
"requester_id": 20978392,
"submitter_id": 76872,
"custom_fields": [
{
"id": 27642,
"value": "745"
},
{
"id": 27648,
"value": "yes"
}
],
"has_incidents": false,
"organization_id": 509974,
"collaborator_ids": [
35334,
234
],
"custom_status_id": 123,
"generated_timestamp": 1304553600,
"satisfaction_rating": {
"id": 1234,
"score": "good",
"comment": "Great support!"
},
"sharing_agreement_ids": [
84432
],
"from_messaging_channel": false
}
}
}update_ticket
Update a ticket's details using its ID, including metadata and ticket information.
Example request and response
{
"request": {
"ticket": {
"status": "solved",
"comment": {
"body": "Thanks for choosing Acme Jet Motors.",
"public": true
},
"brand_id": 123,
"custom_status_id": 321
}
},
"response": {
"audit": {
"events": [
{
"id": 206091192546,
"type": "Create",
"value": "My printer is on fire!",
"field_name": "subject"
},
{
"id": 206091192547,
"body": "The smoke is very colorful.",
"type": "Comment"
},
{
"id": 206091192548,
"type": "Create",
"value": "open",
"field_name": "status"
},
{
"id": 206091192549,
"type": "Create",
"value": 123,
"field_name": "custom_status_id"
}
]
},
"ticket": {
"id": 35436,
"status": "open",
"subject": "My printer is on fire!",
"brand_id": 123,
"requester_id": 123453,
"custom_status_id": 123
}
}
}delete_ticket
Delete a ticket by its unique ticket ID.
list_audits_for_ticket
Retrieve a paginated, sortable list of audit records for a specific ticket, with options to filter events and include detailed metadata.
show_ticket_audit
Retrieve detailed audit information for a specific ticket using its ticket ID and audit ID.
make_ticket_comment_private_from_audits
Make a ticket comment private by updating its visibility from public to private using the ticket and audit IDs.
count_audits_for_ticket
Get the total number of audit records associated with a specific ticket by its ID.
list_ticket_collaborators
Retrieve a list of collaborators associated with a specific ticket using its ticket ID.
list_ticket_comments
Retrieve a paginated list of comments for a specific ticket, with options to include inline images and customize sorting and filtering.
redact_comment_attachment
Redact a specific attachment from a comment within a ticket by providing ticket, comment, and attachment IDs.
make_ticket_comment_private
Mark a specific comment on a ticket as private using ticket and comment IDs.
redact_string_in_comment
Redact a specified string within a comment on a ticket by providing the ticket ID, comment ID, and text to redact.
Example request and response
{
"request": {
"text": "987-65-4320"
}
}count_ticket_comments
Get the total number of comments on a specific ticket by providing its ticket ID.
list_conversation_log_for_ticket
Retrieve the conversation log for a specific ticket, with optional pagination and sorting.
list_ticket_email_ccs
Retrieve the list of email CC addresses associated with a specific ticket by providing the ticket ID.
list_ticket_followers
Retrieve a list of all followers associated with a specific ticket by providing the ticket ID.
list_ticket_group_sla_policy_metrics
Retrieve SLA policy metrics for all group SLAs associated with a specific ticket by its ID.
Example request and response
{
"response": {
"policy_metrics": [
{
"stage": "active",
"metric": "group_ownership_time",
"minutes": -19,
"breach_at": "2023-01-19T02:14:27+00:00"
}
]
}
}list_ticket_incidents
Retrieve a list of incidents associated with a specific ticket by providing the ticket ID.
show_ticket_after_changes
Retrieve a ticket's updated details after applying a specific macro, with optional comment normalization.
mark_ticket_as_spam_and_suspend_requester
Mark a ticket as spam and suspend the user who submitted it by ticket ID.
merge_tickets_into_target_ticket
Merge multiple tickets into a target ticket with optional public or private comments on source and target tickets.
list_ticket_metric_events_by_ticket
Retrieve all metric events associated with a specific ticket using its ticket ID.
Example request and response
{
"response": {
"reply_time": [
{
"id": 4398080142847,
"time": "2023-09-22T02:11:55Z",
"type": "measure",
"metric": "reply_time",
"ticket_id": 2,
"instance_id": 0
},
{
"id": 4398080142975,
"time": "2023-09-22T02:11:55Z",
"type": "fulfill",
"metric": "reply_time",
"ticket_id": 2,
"instance_id": 1
}
]
}
}show_ticket_metrics_by_ticket
Retrieve detailed metrics for a specific ticket using its ticket ID.
list_parent_ticket_references
Retrieve a list of parent tickets associated with the specified ticket ID.
ticket_related_information
Retrieve related information for a specific ticket using its ticket ID.
create_ticket_satisfaction_rating
Submit a satisfaction rating for a specific ticket using its ID.
list_ticket_skips_by_ticket
Retrieve a sorted list of all skips associated with a specific ticket by its ID.
list_ticket_sla_policy_metrics
Retrieve SLA policy metrics for a specific ticket by its ID.
Example request and response
{
"response": {
"policy_metrics": [
{
"stage": "active",
"metric": "first_reply_time",
"minutes": -19,
"breach_at": "2023-01-19T02:14:27+00:00"
}
]
}
}list_resource_tags
Retrieve all tags associated with a specific ticket using its ticket ID.
set_tags_ticket
Add or update tags on a ticket by specifying the ticket ID and a list of tags.
put_tags_ticket
Update tags on a ticket by specifying ticket ID, tags list, and optional parameters for safe update, timestamp, and source method.
delete_tags_ticket
Delete specified tags from a ticket using its ID. Requires ticket ID and list of tags to remove.
create_subticket
Create a subticket under a specific task item within a ticket by providing ticket ID, task item ID, and subticket details.
list_linked_tickets_for_task_item
Retrieve all tickets linked to a specific task item within a ticket using ticket and task item IDs.
link_existing_ticket
Create a link between an existing ticket and a specific task item within another ticket.
unlink_ticket
Remove the link between a ticket and a specific task item using their IDs.
show_task_lists_for_ticket
Retrieve all task lists associated with a specific ticket using its ID.
create_task_list
Create a task list within a ticket by providing the ticket ID and task list details.
autocomplete_tickets
Fetch ticket suggestions based on partial input, filtered by name, support type, field ID, or source for quick ticket identification.
count_tickets
Retrieve the total number of tickets currently available.
Example request and response
{
"response": {
"count": {
"value": 102,
"refreshed_at": "2020-04-06T02:18:17Z"
}
}
}tickets_create_many
Create multiple tickets at once by providing a list of ticket details in a single request.
bulk_delete_tickets
Delete multiple tickets at once by specifying their IDs.
mark_many_tickets_as_spam
Mark multiple tickets as spam in bulk by providing their IDs.
show_ticket_by_messaging_conversation_id
Retrieve ticket details linked to a specific messaging conversation ID.
list_recent_tickets
Retrieve a list of the most recent support tickets with no parameters required.
tickets_show_many
Retrieve details for multiple tickets by specifying their IDs, with optional inclusion of related data.
tickets_update_many
Update multiple tickets simultaneously by specifying their IDs and the desired changes.
list_trigger_categories
Retrieve a paginated, sorted list of ticket trigger categories with optional related data included.
Example request and response
{
"response": {
"meta": {
"has_more": true,
"after_cursor": "eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9",
"before_cursor": "eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9"
},
"links": {
"next": "https://{subdomain}.zendesk.com/api/v2/trigger_categories?include=rule_counts&page[after]=eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9&page[size]=2&sort=position",
"prev": "https://{subdomain}.zendesk.com/api/v2/trigger_categories?include=rule_counts&page[before]=eyJvIjoiLXNjb3JlLGlkIiwidiI6ImFRSUFBQUFBQUFBQWFRMHBJUUVBQUFBQSJ9&page[size]=2&sort=position"
},
"trigger_categories": [
{
"id": "10001",
"name": "Email Triggers",
"position": 0,
"created_at": "2020-07-17T01:30:07Z",
"updated_at": "2020-07-17T01:30:07Z"
},
{
"id": "10002",
"name": "SMS Triggers",
"position": 1,
"created_at": "2020-07-17T01:30:07Z",
"updated_at": "2020-07-17T01:30:07Z"
}
]
}
}create_trigger_category
Create a new ticket trigger category by providing the necessary trigger category details.
Example request and response
{
"request": {
"trigger_category": {
"name": "All Notification Triggers",
"position": 0
}
},
"response": {
"trigger_category": {
"id": "10001",
"name": "All Notification Triggers",
"position": 0,
"created_at": "2020-07-17T01:30:07Z",
"updated_at": "2020-07-17T01:30:07Z"
}
}
}show_trigger_category_by_id
Retrieve detailed information about a specific ticket trigger category using its unique ID.
Example request and response
{
"response": {
"trigger_category": {
"id": "10001",
"name": "All Notification Triggers",
"position": 0,
"created_at": "2020-07-17T01:30:07Z",
"updated_at": "2020-07-17T01:30:07Z"
}
}
}update_trigger_category
Update a ticket trigger category by ID with new category details.
Example request and response
{
"request": {
"trigger_category": {
"name": "All Notification Triggers Updated",
"position": 10
}
},
"response": {
"trigger_category": {
"id": "10001",
"name": "All Notification Triggers Updated",
"position": 10,
"created_at": "2020-07-17T01:30:07Z",
"updated_at": "2020-07-18T05:23:32Z"
}
}
}delete_trigger_category
Delete a ticket trigger category by its ID.
batch_operate_trigger_categories
Create a batch job to manage multiple ticket trigger categories simultaneously via a single API request.
Example request and response
{
"request": {
"job": {
"items": {
"triggers": [
{
"id": "10011",
"active": false,
"position": 10,
"category_id": "10001"
},
{
"id": "10012",
"active": true,
"position": 1,
"category_id": "10002"
}
],
"trigger_categories": [
{
"id": "10001",
"position": 0
},
{
"id": "10002",
"position": 1
}
]
},
"action": "patch"
}
},
"response": {
"status": "complete",
"results": {
"triggers": [
{
"id": 10012,
"url": "http://{subdomain}.zendesk.com/api/v2/triggers/10012",
"title": "Notify Target",
"active": true,
"actions": [
{}
],
"position": 1,
"raw_title": "Notify target",
"conditions": {},
"created_at": "2012-09-25T22:50:26Z",
"updated_at": "2020-07-20T01:30:07Z",
"description": "Notify external target"
},
{
"id": 10011,
"url": "http://{subdomain}.zendesk.com/api/v2/triggers/10011",
"title": "Close and Save",
"active": false,
"actions": [
{}
],
"position": 10,
"raw_title": "Close and Save",
"conditions": {},
"created_at": "2012-09-25T22:50:26Z",
"updated_at": "2020-07-20T01:30:07Z",
"description": "Close and save a ticket"
}
],
"trigger_categories": [
{
"id": "10001",
"name": "Notifications",
"position": 0,
"created_at": "2020-07-18T01:24:53Z",
"updated_at": "2020-07-20T01:30:07Z"
},
{
"id": "10002",
"name": "Apply Tags",
"position": 1,
"created_at": "2020-07-17T06:31:12Z",
"updated_at": "2020-07-20T01:30:07Z"
}
]
}
}
}list_triggers
Retrieve a paginated list of ticket triggers with optional filters for status, sorting, category, and included related data.
create_trigger
Create a new trigger by providing the required trigger details in the request.
get_trigger
Retrieve detailed information about a specific ticket trigger using its unique trigger ID.
update_trigger
Update a ticket trigger by its ID with new trigger details via a PUT request.
delete_trigger
Delete a ticket trigger by its unique ID.
list_trigger_revisions
Retrieve a paginated list of revisions for a specific trigger, with options to limit, order, and include related data.
trigger_revision
Retrieve details of a specific revision for a given ticket trigger, with optional related data included.
list_active_triggers
Retrieve a sorted list of active ticket triggers, optionally filtered by category.
list_trigger_action_condition_definitions
Retrieve a list of available trigger action and condition definitions for automating ticket workflows.
delete_many_triggers
Delete multiple ticket triggers in bulk by specifying their IDs.
show_trigger_limits
Retrieve the current limits and usage details for ticket triggers.
Example request and response
{
"response": {
"count": 42,
"limit": 500
}
}reorder_triggers
Reorder ticket triggers by providing a new sequence of trigger IDs.
search_triggers
Search and retrieve ticket triggers using filters, sorting, and query parameters to find specific active or inactive triggers.
update_many_triggers
Update multiple ticket triggers by providing their details in a single request.
validate_trigger
Validate a ticket trigger configuration with options to fail on validation errors.
Example request and response
{
"request": {
"trigger": {
"title": "Roger Wilco",
"actions": [
{
"field": "group_id",
"value": "20455932"
}
],
"conditions": {
"all": [
{
"field": "status",
"value": "open",
"operator": "is"
}
]
}
}
},
"response": {
"valid": true,
"errors": []
}
}upload_files
Upload files by specifying the filename to send data via a POST request.
delete_upload
Delete an upload by specifying its unique token.
list_user_fields
Retrieve a paginated list of user fields with optional data center resolution.
create_user_field
Create a new custom user field by providing the necessary field details.
show_user_field
Retrieve detailed information about a specific user field by its ID.
update_user_field
Update a specific user field by ID with new data provided in the request.
delete_user_field
Delete a user field by specifying its unique ID.
list_user_field_options
Retrieve all available options for a specific user field by its ID.
create_or_update_user_field_option
Create or update an option for a specific user field by providing the field ID and option details.
show_user_field_option
Retrieve details of a specific option within a user field by providing the user field and option IDs.
delete_user_field_option
Delete a specific option from a user field by providing the user field ID and the option ID.
reorder_user_field
Update the order of user fields by providing a list of user field IDs in the desired sequence.
show_many_user_fields
Retrieve multiple user fields by specifying their keys in a single request.
list_users
Retrieve a paginated list of users filtered by roles, permissions, external IDs, and sorting options.
Example request and response
{
"response": {
"users": [
{
"id": 223443,
"name": "Johnny Agent",
"separation": {
"scope": "brand",
"brand_id": 123
}
},
{
"id": 8678530,
"name": "James A. Rosen",
"separation": {
"scope": "brand",
"brand_id": 123
}
}
]
}
}create_user
Create a new user by providing the required user details in the request body.
Example request and response
{
"request": {
"user": {
"name": "Jamie Rivera",
"role": "end-user",
"identities": [
{
"type": "email",
"value": "household@example.com",
"auto_ownership": true
}
],
"external_id": "household-customer-202"
}
},
"response": {
"user": {
"id": 9873843,
"name": "Roger Wilco",
"role": "agent",
"email": "roge@example.org",
"role_type": 0,
"separation": {
"scope": "brand",
"brand_id": 123
},
"custom_role_id": 123456,
"organization_id": 57542
}
}
}show_user
Retrieve detailed information about a user by their user ID, with optional inclusion of related data.
Example request and response
{
"response": {
"user": {
"id": 35436,
"name": "Johnny Agent",
"separation": {
"scope": "brand",
"brand_id": 123
}
}
}
}update_user
Update a user's details by specifying their user ID and the new user data.
Example request and response
{
"response": {
"user": {
"id": 9873843,
"name": "Roger Wilco II",
"separation": {
"scope": "brand",
"brand_id": 123
}
}
}
}delete_user
Delete a user by their unique user ID.
Example request and response
{
"response": {
"user": {
"id": 9873843,
"name": "Roger Wilco II",
"active": false,
"separation": {
"scope": "brand",
"brand_id": 123
}
}
}
}list_user_brand_agents
Retrieve all brand agent memberships associated with a specific user by their user ID.
show_user_brand_agent_by_id
Retrieve details of a specific brand agent membership for a user by user ID and brand agent ID.
show_user_compliance_deletion_statuses
Retrieve the compliance deletion statuses for a specific user, filtered by application if needed.
get_user_entitlements_full
Retrieve the complete list of entitlements for a specified user by their user ID.
list_user_group_memberships
Retrieve a paginated list of group memberships for a specified user by their user ID.
create_user_group_membership
Add a user to a group by creating a group membership with the specified user ID and group membership details.
show_user_group_membership_by_id
Retrieve details of a specific group membership for a user by user ID and group membership ID.
delete_user_group_membership
Remove a specific group membership from a user by user ID and group membership ID.
group_membership_set_default
Set a specific group membership as the default for a user by user ID and group membership ID.
list_user_groups
Retrieve a paginated, sortable list of groups for a user, with options to exclude deleted groups and include boundary indicators and cursors.
count_user_groups
Get the total number of groups a specific user belongs to by providing their user ID.
list_user_identities
Retrieve a paginated, sorted list of identities linked to a user, with options to filter by type and include pagination details.
create_user_identity
Create a new identity for a user by providing user ID, brand ID, and identity details.
Example request and response
{
"request": {
"identity": {
"type": "email",
"value": "household@example.com",
"auto_ownership": true
}
},
"response": {
"identity": {
"id": 77939,
"type": "email",
"value": "household@example.com",
"primary": true,
"user_id": 202,
"ownership": "shared",
"created_at": "2026-10-22T14:25:21Z",
"updated_at": "2026-10-22T14:25:21Z",
"verification_method": "none"
}
}
}show_user_identity
Retrieve detailed information about a specific identity linked to a user by user ID and identity ID.
update_user_identity
Update a specific user identity by user ID and identity ID with new identity details.
Example request and response
{
"request": {
"identity": {
"ownership": "owned"
}
},
"response": {
"identity": {
"id": 77939,
"type": "email",
"value": "household@example.com",
"primary": true,
"user_id": 202,
"ownership": "owned",
"created_at": "2026-10-22T14:25:21Z",
"updated_at": "2026-10-22T15:25:21Z",
"verification_method": "none"
}
}
}delete_user_identity
Delete a specific identity linked to a user by providing the user ID and identity ID.
make_user_identity_primary
Set a specific user identity as the primary identity for the given user.
request_user_verification
Initiate a verification request for a specific user identity within a brand.
verify_user_identity
Verify a user's identity by updating the verification status for the specified user identity.
merge_end_users
Merge two end user accounts by specifying the target user ID and user details in the request.
Example request and response
{
"response": {
"user": {
"id": 35436,
"name": "Johnny Agent",
"separation": {
"scope": "brand",
"brand_id": 123
}
}
}
}list_user_organization_memberships
Retrieve all organization memberships associated with a specific user by their user ID, with optional inclusion of related data.
create_user_organization_membership
Add a user to an organization by creating their organization membership using the user ID and membership details.
show_organization_membership_by_user_id
Retrieve details of a specific organization membership for a user by user ID and membership ID.
delete_user_organization_membership
Remove a user's membership from a specific organization by user and membership IDs.
set_organization_membership_as_default
Set a specific organization membership as the default for a user by user ID and membership ID.
list_user_organization_subscriptions
Retrieve all organization subscriptions associated with a specific user by their user ID.
list_user_organizations
Retrieve a paginated, sortable list of organizations associated with a specific user by their user ID.
unassign_organization
Remove a user's association with a specific organization by user and organization IDs.
set_organization_as_default
Set the specified organization as the default for the given user by user ID and organization ID.
count_user_organizations
Get the total number of organizations associated with a specific user by their user ID.
set_user_password
Set a new password for the specified user by providing their user ID.
change_own_password
Update your password by providing your user ID and brand ID.
get_user_password_requirements
Retrieve the password complexity and security requirements for a specific user by their user ID.
show_user_related
Retrieve information related to a specific user by their user ID.
list_user_requests
Retrieve a user's requests with optional sorting and filtering by status.
list_user_sessions
Retrieve a list of active and past sessions for a specific user by their user ID.
bulk_delete_sessions_by_user_id
Delete all active sessions for a specified user by their user ID.
show_session
Retrieve detailed information about a specific user session using user ID and session ID.
delete_session
Delete a specific user session by user ID and session ID.
list_ticket_skips
Retrieve a sorted list of ticket skips for a specific user by their user ID.
show_user_suspension
Retrieve the suspension status and details for a specific user by their user ID.
create_user_suspension
Suspend a user by creating a suspension with specified details using their user ID.
update_user_suspension
Suspend or reinstate a user by updating their suspension status using the user ID and suspension details.
delete_user_suspension
Remove the suspension status of a user by their user ID.
list_user_tags
Retrieve all tags associated with a specific user by their user ID.
set_user_tags
Add or update tags for a specific user by providing their user ID and a list of tags.
put_user_tags
Update tags for a user by specifying user ID, tags, and optional parameters like safe update and timestamp.
delete_user_tags
Delete all tags associated with a specific user by their user ID.
list_user_assigned_tickets
Retrieve all tickets currently assigned to a specific user by their user ID.
count_user_assigned_tickets
Get the total number of tickets currently assigned to a specific user by their user ID.
Example request and response
{
"response": {
"count": {
"value": 102,
"refreshed_at": "2020-04-06T02:18:17Z"
}
}
}list_user_ccdtickets
Retrieve a list of CCD tickets associated with a specific user by their user ID.
count_user_ccdtickets
Retrieve the total number of CCD tickets associated with a specific user by their user ID.
Example request and response
{
"response": {
"count": {
"value": 102,
"refreshed_at": "2020-04-06T02:18:17Z"
}
}
}list_user_followed_tickets
Retrieve a paginated, sortable list of tickets followed by a specific user, with options to exclude archived tickets.
list_user_requested_tickets
Retrieve a paginated list of tickets requested by a specific user, with options to sort, filter, and include or exclude archived tickets.
autocomplete_users
Fetch user suggestions by name, phone, or filters with customizable fields, source, inclusion, pagination, and brand options.
Example request and response
{
"response": {
"users": [
{
"id": 35436,
"name": "Robert Jones",
"notes": "sigil issue",
"separation": {
"scope": "brand",
"brand_id": 123
}
},
{
"id": 9873843,
"name": "Terry Gilliam",
"separation": {
"scope": "brand",
"brand_id": 123
}
}
]
}
}autocomplete_users_post
Autocomplete users by various filters like name, phone, brand, and source via POST request with customizable parameters.
Example request and response
{
"request": {
"name": "gil"
},
"response": {
"users": [
{
"id": 35436,
"name": "Robert Jones",
"notes": "sigil issue",
"separation": {
"scope": "brand",
"brand_id": 123
}
},
{
"id": 9873843,
"name": "Terry Gilliam",
"separation": {
"scope": "brand",
"brand_id": 123
}
}
]
}
}count_users
Get the total number of users filtered by role, permission set, or brand ID.
create_many_users
Create multiple users in a single request by providing a list of user details.
create_or_update_user
Create a new user or update an existing user's information with the provided user data.
Example request and response
{
"response": {
"user": {
"id": 9873843,
"name": "Roger Wilco",
"role": "agent",
"email": "roge@example.org",
"role_type": 0,
"separation": {
"scope": "brand",
"brand_id": 123
},
"custom_role_id": 123456,
"organization_id": 57542
}
}
}create_or_update_many_users
Create or update multiple user records in a single request by providing an array of user data.
destroy_many_users
Delete multiple users in bulk by specifying their IDs, external IDs, or associated brand ID.
logout_many_users
Log out multiple users by providing their user IDs in a single request.
show_current_user
Retrieve details of the current authenticated user, with optional inclusion of related data.
Example request and response
{
"response": {
"user": {
"id": 35436,
"url": "https://company.zendesk.com/api/v2/users/35436",
"name": "Johnny Agent",
"role": "agent",
"tags": [
"enterprise",
"other_tag"
],
"alias": "Mr. Johnny",
"email": "johnny@example.com",
"notes": "Johnny is a nice guy!",
"phone": "+15551234567",
"photo": {
"id": 928374,
"name": "my_funny_profile_pic.png",
"size": 166144,
"thumbnails": [
{
"id": 928375,
"name": "my_funny_profile_pic_thumb.png",
"size": 58298,
"content_url": "https://company.zendesk.com/photos/my_funny_profile_pic_thumb.png",
"content_type": "image/png"
}
],
"content_url": "https://company.zendesk.com/photos/my_funny_profile_pic.png",
"content_type": "image/png"
},
"active": true,
"locale": "en-US",
"shared": false,
"details": "",
"verified": true,
"locale_id": 1,
"moderator": true,
"role_type": 0,
"signature": "Have a nice day, Johnny",
"suspended": true,
"time_zone": "Copenhagen",
"created_at": "2009-07-20T22:55:29Z",
"separation": {
"scope": "brand",
"brand_id": 123
},
"updated_at": "2011-05-05T10:38:52Z",
"external_id": "sai989sur98w9",
"user_fields": {
"user_date": "2012-07-23T00:00:00Z",
"user_decimal": 5.1,
"user_dropdown": "option_1"
},
"shared_agent": false,
"last_login_at": "2011-05-05T10:38:52Z",
"custom_role_id": 9373643,
"organization_id": 57542,
"restricted_agent": true,
"authenticity_token": "<CORS TOKEN>",
"ticket_restriction": "assigned",
"only_private_comments": false
}
}
}delete_authenticated_session
Log out the current user by deleting their active authenticated session.
list_current_user_oauth_clients
Retrieve a list of OAuth clients authorized by the current user.
show_currently_authenticated_session
Retrieve details of the currently authenticated user session.
renew_current_session
Renew the active user session to extend its validity without logging out.
show_current_user_settings
Retrieve the current user's personalized settings and preferences.
update_current_user_settings
Update the current user's settings by providing new configuration parameters.
Example request and response
{
"request": {
"settings": {
"lotus": {
"show_onboarding_tooltips": false,
"keyboard_shortcuts_enabled": true,
"agent_workspace_theme_preference": "1"
},
"admin_center": {
"has_admin_center_side_nav_open": true
}
}
}
}request_user_create
Create a new user by submitting the required user details in a POST request.
search_users
Search for users with filters like query, external ID, brand ID, and pagination options.
Example request and response
{
"response": {
"users": [
{
"id": 35436,
"name": "Robert Jones",
"notes": "sigil issue",
"separation": {
"scope": "brand",
"brand_id": 123
}
},
{
"id": 9873843,
"name": "Terry Gilliam",
"separation": {
"scope": "brand",
"brand_id": 123
}
}
]
}
}show_many_users
Retrieve multiple users by IDs or external IDs, with options to include deleted users, filter by brand, and specify related data to include.
Example request and response
{
"response": {
"users": [
{
"id": 345678,
"name": "Johnny Appleseed",
"separation": {
"scope": "brand",
"brand_id": 123
}
},
{
"id": 901234,
"name": "Rupert Root",
"separation": {
"scope": "brand",
"brand_id": 123
}
}
]
}
}update_many_users
Update multiple users by specifying their IDs or external IDs, optionally filtering by brand ID.
list_views
Retrieve a paginated list of views with optional filters for access, status, group, and customizable sorting.
create_view
Create a new view by sending a POST request with no parameters.
show_view
Retrieve detailed information about a specific view by its ID, with optional inclusion of related data.
update_view
Update the details of a specific view using its unique identifier.
delete_view
Delete a specific view by its unique identifier.
get_view_count
Retrieve the total number of tickets in a specified view by providing the view ID.
execute_view
Retrieve and execute a data view by ID with optional pagination, sorting, filtering, and grouping parameters.
export_view
Retrieve and export data from a specific view using its unique identifier.
list_tickets_from_view
Retrieve a sorted list of tickets filtered by a specific view using the view ID, with optional sorting parameters.
list_active_views
Retrieve a sorted list of active views filtered by access level and group ID.
list_compact_views
Retrieve a compact list of all available views with essential details.
count_views
Retrieve the total number of views recorded.
get_view_counts
Retrieve the count of tickets for multiple specified views by providing their IDs.
list_view_definitions
Retrieve a list of all available view filter definitions for customizing data displays.
Example request and response
{
"response": {
"definitions": {
"output": [
{
"type": "tagger",
"group": "ticket",
"title": "ID",
"value": "nice_id"
}
],
"sortables": [
{
"type": "number",
"group": "ticket",
"title": "ID",
"value": "nice_id"
}
],
"groupables": [
{
"type": "list",
"group": "ticket",
"title": "Status",
"value": "status"
}
],
"conditions_all": [
{
"type": "list",
"group": "ticket",
"title": "Status",
"values": [
{
"title": "New",
"value": "new",
"enabled": true
},
{
"title": "Open",
"value": "open",
"enabled": true
}
],
"subject": "status",
"nullable": false,
"operators": [
{
"title": "Is",
"value": "is",
"terminal": false
},
{
"title": "Is not",
"value": "is_not",
"terminal": false
}
],
"repeatable": false
}
],
"conditions_any": [
{
"type": "list",
"group": "ticket",
"title": "Status",
"values": [
{
"title": "New",
"value": "new",
"enabled": true
}
],
"subject": "status",
"nullable": false,
"operators": [
{
"title": "Is",
"value": "is",
"terminal": false
}
],
"repeatable": false
}
]
}
}
}bulk_delete_views
Delete multiple views at once by specifying their IDs.
preview_views
Generate a preview of views with customizable pagination, filtering, and inclusion options by specifying page, per_page, filters, and view details.
preview_count
Get the current count of tickets available for preview.
search_views
Search and filter views by query, access level, status, group, and sorting options.
list_views_by_id
Retrieve multiple views by their IDs, with optional filtering by active status.
update_many_views
Update multiple view configurations simultaneously with a single request.
list_workspaces
Retrieve a list of all available workspaces with their details.
Example request and response
{
"response": {
"count": 1,
"next_page": null,
"workspaces": [
{
"id": 3133,
"url": "https://{subdomain}.zendesk.com/api/v2/workspaces",
"apps": [
{
"id": 360000080413,
"expand": false,
"position": 1
}
],
"title": "Test Workspace 1",
"position": 1,
"activated": true,
"macro_ids": [
360005374974
],
"conditions": {
"all": [
{
"field": "ticket_form_id",
"value": "360000014173",
"operator": "is"
}
],
"any": []
},
"created_at": "2018-11-13T19:08:13Z",
"updated_at": "2018-12-17T22:37:40Z",
"description": "Test rules",
"ticket_form_id": 360000014173,
"selected_macros": [
{
"id": 360005374974,
"url": "https://{subdomain}.zendesk.com/api/v2/macros/360005374974",
"title": "Close and redirect to topics",
"active": true,
"actions": [
{
"field": "status",
"value": "solved"
}
],
"position": 9999,
"usage_7d": 0,
"created_at": "2018-02-08T23:45:30Z",
"updated_at": "2018-11-08T22:27:00Z",
"description": null,
"restriction": {
"id": 360002226093,
"ids": [
360002226093
],
"type": "Group"
}
}
],
"prefer_workspace_app_order": true
}
],
"previous_page": null
}
}create_workspace
Create a new workspace by providing the required workspace details.
Example request and response
{
"request": {
"workspace": {
"title": "Test Workspace 1",
"macros": [
360005374974
],
"conditions": {
"all": [
{
"field": "ticket_form_id",
"value": "360000014173",
"operator": "is"
}
],
"any": []
},
"description": "Test rules",
"ticket_form_id": 360000014173
}
},
"response": {
"workspace": {
"id": 3133,
"url": "https://{subdomain}.zendesk.com/api/v2/workspaces",
"apps": [],
"title": "Test Workspace 1",
"position": 1,
"activated": true,
"macro_ids": [
360005374974
],
"conditions": {
"all": [
{
"field": "ticket_form_id",
"value": "360000014173",
"operator": "is"
}
],
"any": []
},
"created_at": "2018-11-13T19:08:13Z",
"updated_at": "2018-12-17T22:37:40Z",
"description": "Test rules",
"ticket_form_id": 360000014173,
"selected_macros": [
{
"id": 360005374974,
"url": "https://{subdomain}.zendesk.com/api/v2/macros/360005374974",
"title": "Close and redirect to topics",
"active": true,
"actions": [
{
"field": "status",
"value": "solved"
}
],
"position": 9999,
"usage_7d": 0,
"created_at": "2018-02-08T23:45:30Z",
"updated_at": "2018-11-08T22:27:00Z",
"description": null,
"restriction": {
"id": 360002226093,
"ids": [
360002226093
],
"type": "Group"
}
}
],
"prefer_workspace_app_order": true
}
}
}show_workspace
Retrieve detailed information about a workspace using its unique workspace ID.
Example request and response
{
"response": {
"workspace": {
"id": 3133,
"url": "https://{subdomain}.zendesk.com/api/v2/workspaces",
"apps": [],
"title": "Test Workspace 1",
"position": 1,
"activated": true,
"macro_ids": [
360005374974
],
"conditions": {
"all": [
{
"field": "ticket_form_id",
"value": "360000014173",
"operator": "is"
}
],
"any": []
},
"created_at": "2018-11-13T19:08:13Z",
"updated_at": "2018-12-17T22:37:40Z",
"description": "Test rules",
"ticket_form_id": 360000014173,
"selected_macros": [
{
"id": 360005374974,
"url": "https://{subdomain}.zendesk.com/api/v2/macros/360005374974",
"title": "Close and redirect to topics",
"active": true,
"actions": [
{
"field": "status",
"value": "solved"
}
],
"position": 9999,
"usage_7d": 0,
"created_at": "2018-02-08T23:45:30Z",
"updated_at": "2018-11-08T22:27:00Z",
"description": null,
"restriction": {
"id": 360002226093,
"ids": [
360002226093
],
"type": "Group"
}
}
],
"prefer_workspace_app_order": true
}
}
}update_workspace
Update a workspace's details using its ID and new workspace data.
Example request and response
{
"request": {
"workspace": {
"title": "Test Workspace 1",
"macros": [
360005374974
],
"conditions": {
"all": [
{
"field": "ticket_form_id",
"value": "360000014173",
"operator": "is"
}
],
"any": []
},
"description": "Test rules",
"ticket_form_id": 360000014173
}
},
"response": {
"workspace": {
"id": 3133,
"url": "https://{subdomain}.zendesk.com/api/v2/workspaces",
"apps": [],
"title": "Test Workspace 1",
"position": 1,
"activated": true,
"macro_ids": [
360005374974
],
"conditions": {
"all": [
{
"field": "ticket_form_id",
"value": "360000014173",
"operator": "is"
}
],
"any": []
},
"created_at": "2018-11-13T19:08:13Z",
"updated_at": "2018-12-17T22:37:40Z",
"description": "Test rules",
"ticket_form_id": 360000014173,
"selected_macros": [
{
"id": 360005374974,
"url": "https://{subdomain}.zendesk.com/api/v2/macros/360005374974",
"title": "Close and redirect to topics",
"active": true,
"actions": [
{
"field": "status",
"value": "solved"
}
],
"position": 9999,
"usage_7d": 0,
"created_at": "2018-02-08T23:45:30Z",
"updated_at": "2018-11-08T22:27:00Z",
"description": null,
"restriction": {
"id": 360002226093,
"ids": [
360002226093
],
"type": "Group"
}
}
],
"prefer_workspace_app_order": true
}
}
}delete_workspace
Delete a workspace by its unique workspace ID.
destroy_many_workspaces
Delete multiple workspaces at once by providing their IDs.
reorder_workspaces
Reorder workspaces by providing a list of workspace IDs in the desired order.
Example request and response
{
"request": {
"ids": [
12,
32,
48,
60
]
},
"response": ""
}create_token_for_grant_type
Generate an OAuth token using a specified grant type via a POST request. No parameters required.