Zendesk (API Token)

Interact with your Zendesk tickets using API token authentication.

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 495 actions:

Action	Purpose	Parameters
get_api_lotus_assignables_autocomplete_json	List assignable groups and agents based on query matched against name Allowed For Agents	name (string) required
get_api_lotus_assignables_groups_json	List assignable groups on the AssigneeField Allowed For Agents	No parameters
get_api_lotus_assignables_groups_by_group_id_agents_json	List assignable agents from a group on the AssigneeField Allowed For Agents	group_id (integer)
get_api_v2_by_target_type_by_target_id_relationship_fields_by_field_id_by_source_type	Returns a list of source objects whose values are populated with the id of a related target object. For example, if you have a lookup field called 'Success Manager' on a ticket, this endpoint can answer the question, 'What tickets sources is this user found by target_type and target_id assigned as the 'Success Manager' field referenced by field_id?' Allowed For Agents Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/paginatio	target_type (string) target_id (integer) field_id (integer) source_type (string)
get_api_v2_account_settings	Shows the settings that are available for the account. Allowed For Agents	No parameters
put_api_v2_account_settings	Updates settings for the account. See JSON Format json-format above for the settings you can update. Allowed For Admins	No parameters
post_api_v2_accounts	Create Trial Account	No parameters
get_api_v2_accounts_available	Zendesk Support credentials are not required to access this endpoint. You can use any Zendesk Support subdomain. Returns 'true' if the subdomain is available.	subdomain (string) required
get_api_v2_activities	Lists ticket activities in the last 30 days affecting the agent making the request. Also sideloads the following arrays of user records: - actors - All actors involved in the listed activities - users - All users involved in the listed activities Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents	No parameters
get_api_v2_activities_by_activity_id	Lists a specific activity. Allowed For Agents	activity_id (string)
get_api_v2_activities_count	Returns an approximate count of ticket activities in the last 30 days affecting the agent making the request. If the count exceeds 100,000, the count will return a cached result. This cached result will update every 24 hours. The countrefreshed_at property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, countrefreshed_at may occasionally be null. This indicates that the count is being updated in the background, and countvalue is limited to 1	No parameters
post_api_v2_any_channel_channelback_report_error	Allowed For Admins Request parameters The POST request takes a JSON object parameter which contains information about the problematic channelback/documentation/channel_framework/understanding-the-channel-framework/channelback/. | Name | Type | Required | Comments | ------------------ | ----------| --------- | ------------------- | instance_push_id | string | yes | The ID of the account to which data will be pushed. This was passed to the integration	No parameters
post_api_v2_any_channel_push	Pushes Channel framework content to Zendesk. Allowed For Admins Request parameters The POST request takes a JSON object parameter which contains data about all the resources that the client is pushing. | Name | Type | Required | Comments | ------------------ | ----------| --------- | ------------------- | instance_push_id | string | yes | The account ID where data will be pushed. This was passed to the integration service when the administrator set	No parameters
post_api_v2_any_channel_validate_token	Allowed For Admins Request parameters The POST request takes a JSON object parameter which contains the token to be validated. | Name | Type | Required | Comments | ------------------ | ----------| --------- | ------------------- | instance_push_id | string | yes | The ID of the account to which data will be pushed. This was passed to the integration service when the administrator set up the account | request_id | string | no | A un	No parameters
get_api_v2_approval_workflow_instances_by_approval_workflow_instance_id_approval_requests_by_approval_request_id	Shows an approval request. Allowed For Agents	approval_workflow_instance_id (string) approval_request_id (string)
patch_api_v2_approval_workflow_instances_by_approval_workflow_instance_id_approval_requests_by_approval_request_id_decision	Updates the approver's decision about an approval request. Allowed For Agents	approval_workflow_instance_id (string) approval_request_id (string) data: { . notes (string) . status (string) } (object) required
post_api_v2_approval_workflow_instances_by_approval_workflow_instance_id_approval_requests_search	Returns a list of approvals associated with a specific workflow instance. Results can be filtered by approval request status. Allowed For Agents	approval_workflow_instance_id (string)
get_api_v2_attachments_by_attachment_id	Shows attachment details. You can get the value of the attachment_id parameter by listing the ticket's comments. See List Comments/api-reference/ticketing/tickets/ticket_comments/ list-comments. Each comment in the list has an attachments list that specifies an id for each attachment. Allowed for Agents	attachment_id (integer)
put_api_v2_attachments_by_attachment_id	Toggles enabling or restricting agent access to attachments with detected malware. Allowed For Admins	attachment_id (integer) data: { . attachment } (object) required
get_api_v2_audit_logs	Allowed For Admins on accounts that have audit log access Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page.	filtersource_type (string) filtersource_id (integer) filteractor_id (integer) filterip_address (string) filtercreated_at (string) filteraction (string) sort_by (string) sort_order (string) sort (string)
get_api_v2_audit_logs_by_audit_log_id	Allowed For Admins on accounts that have audit-log access	audit_log_id (string)
post_api_v2_audit_logs_export	Allowed For Admins on accounts that have audit log access	filtersource_type (string) filtersource_id (integer) filteractor_id (integer) filterip_address (string) filtercreated_at (string) filteraction (string)
get_api_v2_autocomplete_tags	Returns an array of registered and recent tag names that start with the characters specified in the name query parameter. You must specify at least 2 characters. Pagination Offset pagination only See Using Offset Pagination/api-reference/introduction/pagination/ using-offset-pagination. Allowed For Agents	No parameters
get_api_v2_automations	Lists all automations for the current account. Allowed For Agents Available Parameters You can pass in any combination of the following optional filters: | Name | Type | Comment | ---------- | ------- | ------- | active | boolean | Only active automations if true, inactive automations if false | sort_by | string | Possible values are 'alphabetical', 'created_at', 'updated_at', 'usage_1h', 'usage_24h', or 'usage_7d'. Defaults to 'position' | sort_order | string |	No parameters
post_api_v2_automations	Creates an automation. New automations must be unique and have at least one condition that is true only once or an action that nullifies at least one of the conditions. Active automations can have overlapping conditions but can't be identical. The request must include the following conditions in the all array: - At least one time-based condition - At least one condition that checks one of the following fields: status, type, group_id, assignee_id, or requester_id. Allowed For Agents	No parameters
get_api_v2_automations_by_automation_id	Allowed For Agents	automation_id (string)
put_api_v2_automations_by_automation_id	Updates an automation. Updated automations must be unique and have at least one condition that is true only once or an action that nullifies at least one of the conditions. Active automations can have overlapping conditions but can't be identical. The request must include the following conditions in the all array: - At least one time-based condition - At least one condition that checks one of the following fields: 'status', 'type', 'group_id', 'assignee_id', or 'requester_id' Note: Updating a	automation_id (string)
delete_api_v2_automations_by_automation_id	Note: You might be restricted from deleting some default automations. Allowed For Agents	automation_id (string)
get_api_v2_automations_active	Lists all active automations. Allowed For Agents Available Parameters You can pass in any combination of the following optional filters: | Name | Type | Comment | ---------- | ------ | ------- | sort_by | string | Possible values are 'alphabetical', 'created_at', 'updated_at', 'usage_1h', 'usage_24h', or 'usage_7d'. Defaults to 'position' | sort_order | string | One of 'asc' or 'desc'. Defaults to 'asc' for alphabetical and position sort, 'desc' for all others Si	No parameters
delete_api_v2_automations_destroy_many	Deletes the automations corresponding to the provided comma-separated list of IDs. Note: You might be restricted from deleting some default automations. If included in a bulk deletion, the unrestricted automations will be deleted. Allowed For Agents Request Parameters The DELETE request takes one parameter, an ids object that lists the automations to delete. | Name | Description | ---- | ----------- | ids | The IDs of the automations to delete Example request 'ids': '25,	ids (array)
get_api_v2_automations_search	Pagination Offset pagination only See Using Offset Pagination/api-reference/introduction/pagination/ using-offset-pagination. Allowed For Agents Sideloads The following sideloads are supported. For more information, see Side-loading/documentation/ticketing/using-the-zendesk-api/side_loading/. | Name | Will sideload | ---------------- | ------------- | app_installation | The app installation that requires each automation, if present | permissions | The per	No parameters
put_api_v2_automations_update_many	Note: You might be restricted from updating some default automations. If included in a bulk update, the unrestricted automations will be updated. Allowed For Agents Request Parameters The PUT request expects an automations object that lists the automations to update. Each automation may have the following properties: | Name | Mandatory | Description | -------- | --------- | ----------- | id | yes | The ID of the automation to update | position | no | The n	No parameters
get_api_v2_bookmarks	Allowed For - Agents	No parameters
post_api_v2_bookmarks	Allowed For - Agents	data: { . bookmark } (object) required
delete_api_v2_bookmarks_by_bookmark_id	Allowed For - Agents own bookmarks only If the bookmark already exists with a specified ticket id, the response status will be http Status: 200 OK.	bookmark_id (string)
get_api_v2_brand_agents	Returns a list of all brand agent memberships for your account. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For: Admins	user_id (integer) brand_id (integer)
get_api_v2_brand_agents_by_brand_agent_id	Returns a brand agent membership for your account. Allowed For Admins	brand_agent_id (string)
get_api_v2_brands	Returns a list of all brands for your account sorted by name. Allowed for Admins Agents with the assign_tickets_to_any_brand permission can list all brands for the account Agents without the assign_tickets_to_any_brand permission can only list brands they are members of Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/.	No parameters
post_api_v2_brands	Allowed for - Admins	data: { . brand } (object) required
get_api_v2_brands_by_brand_id	Returns a brand for your account. Allowed for Admins, Agents	brand_id (integer)
put_api_v2_brands_by_brand_id	Returns an updated brand. Allowed for Admins Updating a Brand's Image A brand image can be updated by uploading a local file using the update brand endpoint. See the Using curl sections below for more information.	brand_id (integer) data: { . brand } (object) required
delete_api_v2_brands_by_brand_id	Deletes a brand. Allowed for - Admins	brand_id (integer)
get_api_v2_brands_by_brand_id_check_host_mapping	Returns a JSON object determining whether a host mapping is valid for the given brand. Allowed for - Admins	brand_id (integer)
get_api_v2_brands_check_host_mapping	Returns a JSON object determining whether a host mapping is valid for a given subdomain. Allowed for Admins	host_mapping (string) required subdomain (string) required
get_api_v2_channels_twitter_monitored_twitter_handles	Allowed For Admins Agents	No parameters
get_api_v2_channels_twitter_monitored_twitter_handles_by_monitored_twitter_handle_id	Allowed For Admins Agents	monitored_twitter_handle_id (string)
post_api_v2_channels_twitter_tickets	Turns a tweet into a ticket. You must provide the tweet id as well as the id of a monitored X formerly Twitter handle configured for your account. The submitter of the ticket is set to be the user submitting the API request. Allowed For Agents	No parameters
get_api_v2_channels_twitter_tickets_by_comment_id_statuses	Allowed For Agents	comment_id (string) ids (string)
post_api_v2_channels_voice_agents_by_agent_id_tickets_by_ticket_id_display	Allows you to instruct an agent's browser to open a ticket. When the message is successfully delivered to an agent's browser: http Status: 200 OK When agent_id or ticket_id is invalid: http Status: 404 Not Found Allowed For Agents	agent_id (integer) ticket_id (integer)
post_api_v2_channels_voice_agents_by_agent_id_users_by_user_id_display	Allows you to instruct an agent's browser to open a user's profile. When the message is successfully delivered to an agent's browser: http Status: 200 OK When agent_id or user_id is invalid: http Status: 404 Not Found Allowed For Agents	agent_id (integer) user_id (integer)
post_api_v2_channels_voice_tickets	Allowed For Agents Creating tickets Introduction Creating tickets using Talk Partner Edition follows the same conventions as the Create Ticket endpoint. See Create Ticket/api-reference/ticketing/tickets/tickets/ create-ticket. Request parameters The POST request takes a mandatory ticket object that lists the values to set when the ticket is created. You may also include an optional display_to_agent value such as the ID of the agent that will see the newly created ticket.	agent_id (integer) ticket_id (integer) data: { . display_to_agent (integer) . ticket (object) } (object) required
put_api_v2_chat_file_redactions_by_ticket_id	Permanently removes one or more chat attachments from a chat ticket. Note: This does not work on active chats. For chat tickets that predate March 2020, consider using Redact Ticket Comment In Agent Workspace redact-ticket-comment-in-agent-workspace. Allowed For - Agents Agent Workspacehttps://support.zendesk.com/hc/en-us/articles/360024218473 must enabled for the account. Deleting tickets must be enabled for agents. Request Body Properties | Name | Type | Required | D	ticket_id (string)
put_api_v2_chat_redactions_by_ticket_id	Permanently removes words or strings from a chat ticket's comment. Wrap redact tags around the content in the chat comment you want redacted. Example: json 'text': 'My ID number is redact847564/redact!' The characters contained in the tag will be replaced by the ▇ symbol. Note: This does not work on active chats. For chat tickets that predate March 2020, consider using Redact Ticket Comment In Agent Workspace redact-ticket-comment-in-agent-workspace. Allowed For - Agents Agent	ticket_id (string)
put_api_v2_comment_redactions_by_ticket_comment_id	Redaction allows you to permanently remove words, strings, or attachments from a ticket comment. In the html_body of the comment, wrap the content you want redacted in redact tags. Example: json 'html_body': 'div class='zd-comment' dir='auto'My ID number is redact847564/redact!/div', 'ticket_id':100 The characters in the redact tag will be replaced by the ▇ symbol. To redact HTML elements such inline images, anchor tags, and links, add the redact tag attribute to the element as well a	ticket_comment_id (string)
get_api_v2_custom_objects	Lists all undeleted custom objects for the account Allowed For Agents	No parameters
post_api_v2_custom_objects	Creates an object describing all the properties required to create a custom object record Allowed For Admins	data: { . custom_object } (object) required
get_api_v2_custom_objects_by_custom_object_key	Returns an object with the specified key Allowed For Agents	custom_object_key (string)
patch_api_v2_custom_objects_by_custom_object_key	Updates an individual custom object. The updating rules are as follows: Takes a custom_object object that specifies the properties to update The key property cannot be updated Allowed For Admins	custom_object_key (string)
delete_api_v2_custom_objects_by_custom_object_key	Permanently deletes the custom object with the specified key Allowed For Admins	custom_object_key (string)
get_api_v2_custom_objects_by_custom_object_key_fields	Lists all undeleted custom fields for the specified object. Allowed For Agents Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/.	custom_object_key (string) include_standard_fields (boolean)
post_api_v2_custom_objects_by_custom_object_key_fields	Creates any of the following custom field types: text default when no 'type' is specified textarea checkbox date integer decimal regexp dropdown lookup multiselect See About custom field typeshttps://support.zendesk.com/hc/en-us/articles/203661866 in Zendesk help. Allowed For Admins	custom_object_key (string) data: { . custom_object_field } (object) required
get_api_v2_custom_objects_by_custom_object_key_fields_by_custom_object_field_key_or_id	Returns a custom field for a specific object using a provided key or id of the field. Allowed For Agents	custom_object_key (string) custom_object_field_key_or_id (string)
patch_api_v2_custom_objects_by_custom_object_key_fields_by_custom_object_field_key_or_id	Updates individual custom object fields. The updating rules are as follows: Takes a custom_object_field object that specifies the properties to update The key property cannot be updated If updating a standard field, only the title, description, and properties attributes can be updated. The properties parameter is comprised of four parts and can't be changed if any records exist for the object. autoincrement_enabled: A Boolean that enables and disables autonumbering. Must be false if is_	custom_object_key (string) custom_object_field_key_or_id (string)
delete_api_v2_custom_objects_by_custom_object_key_fields_by_custom_object_field_key_or_id	Deletes a field with the specified key. Note: You can't delete standard fields. Allowed For Admins	custom_object_key (string) custom_object_field_key_or_id (string)
put_api_v2_custom_objects_by_custom_object_key_fields_reorder	Sets a preferred order of custom fields for a specific object by providing field ids in the desired order. Allowed For Admins	custom_object_key (string)
post_api_v2_custom_objects_by_custom_object_key_jobs	Queues a background job to perform bulk actions on up to 100 custom object records per single request. Takes a job object with two nested fields: action, one of: 'create' 'delete' 'delete_by_external_id' 'create_or_update_by_external_id' 'create_or_update_by_name' 'update' items For a 'create' action, an array of JSON objects representing the custom object records being created For a 'delete' action, an array of strings representing Zendesk record ids	custom_object_key (string) data: { . job (object) } (object) required
get_api_v2_custom_objects_by_custom_object_key_limits_field_limit	List the current count and the limit for a custom object's fields Allowed For Agents	custom_object_key (string)
get_api_v2_custom_objects_by_custom_object_key_records	Lists all undeleted custom object records for the specified object Pagination Cursor pagination/api-reference/introduction/pagination/ cursor-pagination only. Allowed For Agents	custom_object_key (string) filterids (string) filterexternal_ids (string) sort (string) pagebefore (string) pageafter (string) pagesize (integer)
post_api_v2_custom_objects_by_custom_object_key_records	Creates a custom object record according to all the properties described by a custom object definition. If autoincrement_enabled is true, record names aren't allowed in the request body because they are generated automatically. If is_unique is true, record names must be unique. Allowed For Agents	custom_object_key (string) data: { . custom_object_record } (object) required
patch_api_v2_custom_objects_by_custom_object_key_records	If a record exists for the given external id or name, updates it. Only the specified attributes are updated. Otherwise, creates a new record with the provided external id, name and other attributes. The is_unqiue property on the custom object's name field must be enabled in order to update or create by name. External id and name cannot be used together in the same request. Allowed For Agents	custom_object_key (string) external_id (string) required name (string) required data: { . custom_object_record } (object) required
delete_api_v2_custom_objects_by_custom_object_key_records	Deletes a record with the specified external id or name. The is_unique property on the custom object's name field must be enabled in order to delete by name. External id and name cannot be used together in the same request. Allowed For Agents	custom_object_key (string) external_id (string) required name (string) required
get_api_v2_custom_objects_by_custom_object_key_records_by_custom_object_record_id	Returns a custom record for a specific object using a provided id. Allowed For Agents	custom_object_key (string) custom_object_record_id (string)
patch_api_v2_custom_objects_by_custom_object_key_records_by_custom_object_record_id	Updates an individual custom object record. The updating rules are as follows: Takes a custom_object_record object that specifies the properties to update The custom object fields should be nested inside a custom_object_fields object Allowed For Agents	custom_object_key (string) custom_object_record_id (string)
delete_api_v2_custom_objects_by_custom_object_key_records_by_custom_object_record_id	Deletes a record with the specified id Allowed For Agents	custom_object_key (string) custom_object_record_id (string)
get_api_v2_custom_objects_by_custom_object_key_records_autocomplete	Retrieves an array of custom object records that have a field value that matches the value specified in the name parameter. Pagination Cursor pagination/api-reference/introduction/pagination/ cursor-pagination only. Returns the first 10,000 records sorted by relevancy with page limits. Allowed For Agents	custom_object_key (string) name (string) pagebefore (string) pageafter (string) pagesize (integer) field_id (string) source (string) filterdynamic_values (object) requester_id (integer) assignee_id (integer) organization_id (integer)
get_api_v2_custom_objects_by_custom_object_key_records_count	Returns a total count of records for a specific custom object as well as the time the count was refreshed. Allowed For Agents	custom_object_key (string)
get_api_v2_custom_objects_by_custom_object_key_records_search	Returns an array of custom object records that meet the search criteria Pagination Cursor pagination/api-reference/introduction/pagination/ cursor-pagination only. Returns the records sorted by relevancy with page limits. Without a sort parameter, only the first 10,000 records are returned. With a sort parameter, all records are returned. Allowed For Agents	custom_object_key (string) query (string) sort (string) pagebefore (string) pageafter (string) pagesize (integer)
post_api_v2_custom_objects_by_custom_object_key_records_search	Returns an array of custom object records that meet the search and filter criteria. Filters can contain either an individual comparison object comparison-object or an array of comparison objects comparison-object within logical namespaces. A filter is a JSON object that has the following properties: | Name | Type | Required | Description | --------- | ------ | -------- | ----------- | ATTRIBUTE | object | no | A comparison object comparison-object specifying an attribute value co	custom_object_key (string) query (string) sort (string) pagebefore (string) pageafter (string) pagesize (integer) data (undefined) required
get_api_v2_custom_objects_by_custom_object_key_triggers	Lists all triggers for the specified custom object. Allowed For Agents	custom_object_key (string) active (boolean) sort_by (string) sort_order (string)
post_api_v2_custom_objects_by_custom_object_key_triggers	Creates a new object trigger for a specified object. Allowed For Administrators Agents in custom roles with the manage_triggers permission Enterprise only	custom_object_key (string) data: { . trigger } (object) required
get_api_v2_custom_objects_by_custom_object_key_triggers_by_trigger_id	Returns details of a specific object trigger. Allowed For Agents	custom_object_key (string) trigger_id (string)
put_api_v2_custom_objects_by_custom_object_key_triggers_by_trigger_id	Updates a specified object trigger. Note: Updating a condition or action updates both the conditions and actions arrays, clearing all existing values of both arrays. Include all your conditions and actions when updating any condition or action. Allowed For Administrators Agents in custom roles with the manage_triggers permission Enterprise only	custom_object_key (string) trigger_id (string) data: { . trigger } (object) required
delete_api_v2_custom_objects_by_custom_object_key_triggers_by_trigger_id	Deletes a specified object trigger. Allowed For Administrators Agents in custom roles with the manage_triggers permission Enterprise only	custom_object_key (string) trigger_id (string)
get_api_v2_custom_objects_by_custom_object_key_triggers_active	Lists all active object triggers. Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Administrators Agents in custom roles with the manage_triggers permission Enterprise only	custom_object_key (string)
get_api_v2_custom_objects_by_custom_object_key_triggers_definitions	Lists the conditions and actions of all triggers for the specified custom object. Allowed For Agents	custom_object_key (string)
delete_api_v2_custom_objects_by_custom_object_key_triggers_destroy_many	Deletes the object triggers corresponding to the provided comma-separated list of ids. Note: You can only bulk-delete triggers associated with one object at a time, specified by the custom_object_key in the request. Allowed For Administrators Agents in custom roles with the manage_triggers permission Enterprise only Request Parameters The DELETE request takes an ids object that lists the object triggers to delete. All of the specified object trigger ids must be associated with	custom_object_key (string)
get_api_v2_custom_objects_by_custom_object_key_triggers_search	Returns a list of object triggers that meet your filter or search criteria. Pagination Offset pagination only See Using Offset Pagination/api-reference/introduction/pagination/ using-offset-pagination. Allowed For Agents Filter Use the filter query parameter to filter an object trigger search by one or more attributes. For example, the following filter argument filters object triggers by the title attribute: json 'json': 'title': 'test'	custom_object_key (string)
put_api_v2_custom_objects_by_custom_object_key_triggers_update_many	Updates the position or the active status of multiple object triggers. Any additional properties are ignored. Note: You can only bulk-update triggers associated with one object at a time, specified by the custom_object_key in the request. Allowed For Administrators Agents in custom roles with the manage_triggers permission Enterprise only Request Parameters The PUT request expects a triggers object that lists the object triggers to update. All of the specified object trigger ids	custom_object_key (string) data: { . triggers (array) } (object) required
get_api_v2_custom_objects_limits_object_limit	List the current count and the limit for custom objects Allowed For Admins	No parameters
get_api_v2_custom_objects_limits_record_limit	List the current count and the limit for custom object records Allowed For Agents	No parameters
get_api_v2_custom_roles	Availability Accounts on the Enterprise plan or above Allowed For Agents	No parameters
post_api_v2_custom_roles	Availability Accounts on the Enterprise plan or above Allowed for Administrators Agents with the manage_roles permission	No parameters
get_api_v2_custom_roles_by_custom_role_id	Availability Accounts on the Enterprise plan or above Allowed for Administrators Agents with the manage_roles permission	custom_role_id (string)
put_api_v2_custom_roles_by_custom_role_id	Availability Accounts on the Enterprise plan or above Allowed for Administrators Agents with the manage_roles permission	custom_role_id (string)
delete_api_v2_custom_roles_by_custom_role_id	Availability Accounts on the Enterprise plan or above Allowed for Administrators Agents with the manage_roles permission	custom_role_id (string)
put_api_v2_custom_status_default	Updates the default values for many custom ticket statuses at once. Allowed For Admins	data: { . ids (string) } (object) required
get_api_v2_custom_statuses	Lists all undeleted custom ticket statuses for the account. No pagination is provided. Allowed For End Users	status_categories (string) active (boolean) default (boolean)
post_api_v2_custom_statuses	Takes a custom_status object that specifies the custom ticket status properties to create. Allowed For Admins	data: { . custom_status } (object) required
get_api_v2_custom_statuses_by_custom_status_id	Returns the custom ticket status object. Allowed For End Users	custom_status_id (integer)
put_api_v2_custom_statuses_by_custom_status_id	Takes a custom_status object that specifies the properties to update. Allowed For Admins	custom_status_id (integer) data: { . custom_status } (object) required
post_api_v2_custom_statuses_by_custom_status_id_ticket_form_statuses	Creates one or many tickets form status associations for a custom status. Allowed For Admins	custom_status_id (string) data: { . ticket_form_status (array) } (object) required
get_api_v2_deleted_tickets	Returns a maximum of 100 deleted tickets per page. See Pagination/api-reference/introduction/pagination/. The results includes all deleted and not yet archived tickets that have not yet been scrubbedhttps://support.zendesk.com/hc/en-us/articles/4408845703194 topic_fv5_w51_sdb in the past 30 days. Archived tickets are not included in the results. See About archived ticketshttps://support.zendesk.com/hc/en-us/articles/203657756 in the Support Help Center. The tickets are ordered chronologically	sort_by (string) sort_order (string)
delete_api_v2_deleted_tickets_by_ticket_id	Permanently deletes a soft-deleted ticket. See Soft deletehttps://support.zendesk.com/hc/en-us/articles/4408834005530 topic_zrm_wbj_1db in the Zendesk GDPR docs. To soft delete a ticket, use the Delete Ticket delete-ticket endpoint. This endpoint enqueues a ticket deletion job and returns a payload with the jobs status. If the job succeeds, the ticket is permanently deleted. This operation can't be undone. This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-managemen	ticket_id (integer)
put_api_v2_deleted_tickets_by_ticket_id_restore	Allowed For Agents	ticket_id (integer)
delete_api_v2_deleted_tickets_destroy_many	Permanently deletes up to 100 soft-deleted tickets. See Soft deletehttps://support.zendesk.com/hc/en-us/articles/4408834005530 topic_zrm_wbj_1db in the Zendesk GDPR docs. To soft delete tickets, use the Bulk Delete Tickets bulk-delete-tickets endpoint. This endpoint accepts a comma-separated list of up to 100 ticket ids. It enqueues a ticket deletion job and returns a payload with the jobs status. If one ticket fails to be deleted, the endpoint still attempts to delete the others. If the job s	ids (string) required
put_api_v2_deleted_tickets_restore_many	Allowed For Agents	ids (string) required
get_api_v2_deleted_users	Returns deleted users, including permanently deleted users. If the results contains permanently deleted users, the users' properties that normally contain personal data, such as email and phone, are null. The name property is 'Permanently Deleted User'. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents	No parameters
get_api_v2_deleted_users_by_deleted_user_id	Returns users that have been deleted but not permanently yet. See Permanently Delete User permanently-delete-user. Allowed For: Agents	deleted_user_id (string)
delete_api_v2_deleted_users_by_deleted_user_id	Before permanently deleting a user, you must delete the user first. See Delete User/api-reference/ticketing/users/users/ delete-user. WARNING: Permanently deleting a user deletes all of their information. This information is not recoverable. Permanent user deletion rate limit You can permanently delete 700 users every 10 minutes. The rate limiting mechanism behaves as described in Rates Limits/api-reference/introduction/rate-limits/ monitoring-your-request-activity in the API introductio	deleted_user_id (string)
get_api_v2_deleted_users_count	Returns an approximate count of deleted users, including permanently deleted users. If the count exceeds 100,000, it is updated every 24 hours. The response includes a refreshed_at property in a count object that contains a timestamp indicating when the count was last updated. Note: When the count exceeds 100,000, countrefreshed_at may occasionally be null. This indicates that the count is being updated in the background, and countvalue is limited to 100,000 until the update is complete.	No parameters
get_api_v2_deletion_schedules	Lists all deletion schedules for the account. Deletion schedules are used to automatically delete data from the account after a certain period of time. Allowed For Admins	No parameters
post_api_v2_deletion_schedules	Creates a new deletion schedule. Allowed For Admins	data: { . deletion_schedule (object) } (object) required
get_api_v2_deletion_schedules_by_deletion_schedule_id	Gets a deletion schedule by its id. Allowed For Admins	deletion_schedule_id (integer)
put_api_v2_deletion_schedules_by_deletion_schedule_id	Updates a deletion schedule by its id. Note: Updating a condition updates the conditions array, clearing all existing values of the array. Include all your conditions when updating any condition. Allowed For Admins	deletion_schedule_id (integer) data: { . deletion_schedule (object) } (object) required
delete_api_v2_deletion_schedules_by_deletion_schedule_id	Deletes a deletion schedule by its id. Allowed For Admins	deletion_schedule_id (integer)
get_api_v2_dynamic_content_items	Returns a list of all dynamic content items for your account if accessed as an admin or agents who have permission to manage dynamic content. Allowed For Admins, Agents Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/.	No parameters
post_api_v2_dynamic_content_items	Create a new content item, with one or more variants in the item's variants array. See Specifying item variants specifying-item-variants. The default_locale_id and variant locale_id values must be one of the locales the account has active. You can get the list with the List Locales/api-reference/ticketing/account-configuration/locales/ list-locales endpoint. Allowed For Admins, Agents	No parameters
get_api_v2_dynamic_content_items_by_dynamic_content_item_id	Allowed For Admins, Agents	dynamic_content_item_id (string)
put_api_v2_dynamic_content_items_by_dynamic_content_item_id	The only attribute you can change is the name. To add a variant to the item, or to update or delete the variants of the item, use the Item Variants API/api-reference/ticketing/ticket-management/dynamic_content_item_variants/ update-many-variants. Allowed For Admins, Agents	dynamic_content_item_id (string)
delete_api_v2_dynamic_content_items_by_dynamic_content_item_id	Allowed For Admins, Agents	dynamic_content_item_id (string)
get_api_v2_dynamic_content_items_by_dynamic_content_item_id_variants	Returns all the variants of the specified dynamic content item. Allowed For Admins Agents who have permission to manage dynamic content Pagination Cursor pagination See Pagination/api-reference/introduction/pagination/.	dynamic_content_item_id (string)
post_api_v2_dynamic_content_items_by_dynamic_content_item_id_variants	You can only create one variant for each locale id. If a locale variant already exists, the request is rejected. Allowed For Admins, Agents	dynamic_content_item_id (string)
get_api_v2_dynamic_content_items_by_dynamic_content_item_id_variants_by_dynamic_content_variant_id	Allowed For Admins, Agents	dynamic_content_item_id (string) dynamic_content_variant_id (string)
put_api_v2_dynamic_content_items_by_dynamic_content_item_id_variants_by_dynamic_content_variant_id	Updates the specified variant. You don't need to include all the properties. If you just want to update content, for example, then include just that. You can't switch the active state of the default variant of an item. Similarly, you can't switch the default to false if the variant is the default. You must make another variant default instead. Allowed For Admins, Agents	dynamic_content_item_id (string) dynamic_content_variant_id (string)
delete_api_v2_dynamic_content_items_by_dynamic_content_item_id_variants_by_dynamic_content_variant_id	Allowed For Admins, Agents	dynamic_content_item_id (string) dynamic_content_variant_id (string)
post_api_v2_dynamic_content_items_by_dynamic_content_item_id_variants_create_many	Allowed For Admins, Agents	dynamic_content_item_id (string)
put_api_v2_dynamic_content_items_by_dynamic_content_item_id_variants_update_many	Updates one or more variants. See Update Variant/api-reference/ticketing/ticket-management/dynamic_content_item_variants/ update-variant. You must specify the variants by id in the body. To get the variant ids, see List Variants/api-reference/ticketing/ticket-management/dynamic_content_item_variants/ list-variants. Allowed For Admins, Agents	dynamic_content_item_id (string)
get_api_v2_dynamic_content_items_show_many	Stability Development Allowed For Admins, Agents	identifiers (string)
get_api_v2_email_notifications	Allowed For Agents Request parameters Filters Important: You must specify a filter query parameter to narrow the scope of the search for this endpoint. By notification: api/v2/email_notifications.json?filternotification_id=7824075373693 By comment: api/v2/email_notifications.json?filtercomment_id=782407 By ticket: api/v2/email_notifications.json?filterticket_id=623 Pagination By default, a maximum of 100 email notifications are included per page. Use cursor-based	No parameters
get_api_v2_email_notifications_by_notification_id	Shows details on an email notification. You can get the value of the notification_id parameter by listing the ticket's outbound emails. Allowed For Agents	notification_id (string)
get_api_v2_email_notifications_show_many	Shows details of many email notifications. Allows you to query by providing a list of notifications, comments, or tickets IDs. Allowed For Agents Filters By notification: ?ids=8433702508541,8433348111869 By comment: ?comment_ids=8433348111741,8433544226045,8433702508413 By ticket: ?ticket_ids=730,723	No parameters
get_api_v2_group_memberships	Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For: Agents	group_id (integer) user_id (integer)
post_api_v2_group_memberships	Assigns an agent to a given group. Allowed For Admins Agents assigned to a custom role with permissions to manage group memberships Enterprise only	No parameters
get_api_v2_group_memberships_by_group_membership_id	The 'id' is the group membership id, not a group id. Allowed For Agents	group_membership_id (string)
delete_api_v2_group_memberships_by_group_membership_id	Immediately removes a user from a group and schedules a job to unassign all working tickets that are assigned to the given user and group combination. Allowed For Admins Agents assigned to a custom role with permissions to manage group memberships Enterprise only	group_membership_id (string)
get_api_v2_group_memberships_assignable	Returns a maximum of 100 group memberships per page. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For: Agents	No parameters
post_api_v2_group_memberships_create_many	Assigns up to 100 agents to given groups. Allowed For Admins Agents assigned to a custom role with permissions to manage group memberships Enterprise only Response This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-management/job_statuses/ json-format and queues a background job to do the work. Use the Show Job Status/api-reference/ticketing/ticket-management/job_statuses/ show-job-status endpoint to check for the job's completion.	No parameters
delete_api_v2_group_memberships_destroy_many	Immediately removes users from groups and schedules a job to unassign all working tickets that are assigned to the given user and group combinations. Allowed For Admins Agents assigned to a custom role with permissions to manage group memberships Enterprise only	ids (string)
get_api_v2_group_slas_policies	Allowed For Admins	No parameters
post_api_v2_group_slas_policies	Allowed For Admins	No parameters
get_api_v2_group_slas_policies_by_group_sla_policy_id	Allowed For Admins	group_sla_policy_id (string)
put_api_v2_group_slas_policies_by_group_sla_policy_id	Updates the specified policy. Allowed For Admins	group_sla_policy_id (string)
delete_api_v2_group_slas_policies_by_group_sla_policy_id	Allowed For Admins	group_sla_policy_id (string)
get_api_v2_group_slas_policies_definitions	Allowed For Admins	No parameters
put_api_v2_group_slas_policies_reorder	Allowed For Admins	group_sla_policy_ids (array)
get_api_v2_groups	Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Admins Agents	user_id (integer) exclude_deleted (boolean)
post_api_v2_groups	Allowed For Admins Agents assigned to a custom role with permissions to manage groups Enterprise only	No parameters
get_api_v2_groups_by_group_id	Allowed For Admins Agents	group_id (string)
put_api_v2_groups_by_group_id	Allowed For Admins	group_id (string)
delete_api_v2_groups_by_group_id	Allowed For Admins Agents assigned to a custom role with permissions to manage groups Enterprise only	group_id (string)
get_api_v2_groups_assignable	Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Admins Agents	No parameters
get_api_v2_groups_count	Returns an approximate count of groups. If the count exceeds 100,000, it is updated every 24 hours. The refreshed_at property of the count object is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, refreshed_at may occasionally be null. This indicates that the count is being updated in the background, and the value property of the count object is limited to 100,000 until the update is complete. Allowed For Admins Agents	No parameters
post_api_v2_imports_tickets	Allowed For Admins	archive_immediately (boolean) data: { . ticket } (object) required
post_api_v2_imports_tickets_create_many	Accepts an array of up to 100 ticket objects. Allowed For Admins	archive_immediately (boolean) data: { . tickets (array) } (object) required
get_api_v2_incremental_by_incremental_resource_sample	Use this endpoint to test the incremental export format. It's more strict in terms of rate limiting, at 10 requests per 20 minutes instead of 10 requests per minute. It also returns only up to 50 results per request. Otherwise, it's identical to the above APIs. Use the incremental_resource parameter to specify the resource. Possible values are 'tickets', 'ticket_events', 'users', or 'organizations'.	incremental_resource (string)
get_api_v2_incremental_organizations	Allowed For Admins Sideloading See Organizations sideloads/documentation/ticketing/using-the-zendesk-api/side_loading/ supported-endpoints.	No parameters
get_api_v2_incremental_routing_attribute_values	Returns a stream of changes that occurred on routing attribute values. Allowed For Admins Parameters Optional | Name | Type | Comment | ------ | ------ | ------- | cursor | string | The cursor parameter is a non-human-readable argument you can use to move forward or backward in time. The cursor is a read-only URL parameter that's only available in API responses. See Pagination pagination.	No parameters
get_api_v2_incremental_routing_attributes	Returns a stream of changes that occurred on routing attributes. Allowed For Admins Parameters Optional | Name | Type | Comment | ------ | ------ | ------- | cursor | string | The cursor parameter is a non-human-readable argument you can use to move forward or backward in time. The cursor is a read-only URL parameter that's only available in API responses. See Pagination pagination.	No parameters
get_api_v2_incremental_routing_instance_values	Returns a stream of changes that occurred on routing instance values. Changes are grouped by attribute_value_id, with associate type events listed alongside unassociate type events based on the unassociate event’s timestamp. Allowed For Admins Parameters Optional | Name | Type | Comment | ------ | ------ | ------- | cursor | string | The cursor parameter is a non-human-readable argument you can use to move forward or backward in time. The cursor is a read-only URL parameter t	No parameters
get_api_v2_incremental_ticket_events	Returns a stream of changes that occurred on tickets, excluding events occuring within one minute of the request. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. For more information, see: - Exporting ticket events/documentation/ticketing/managing-tickets/using-the-incremental-export-api exporting-ticket-events in Using the Incremental Exports API/documentation/ticketing/managing-tickets/using-the-incremental-export-api - Time-based incr	No parameters
get_api_v2_incremental_ticket_metric_events	Returns ticket metric events that occurred on or after the start time. Cursor pagination returns a maximum of 100 records per page. Events are listed in chronological order. If the results are not paginated, events will be returned as a time-based incremental export. See Time-based incremental exports/documentation/ticketing/managing-tickets/using-the-incremental-export-api time-based-incremental-exports. Pagination Cursor pagination See Pagination/api-reference/introduction/paginatio	start_time (integer) required include_changes (boolean)
get_api_v2_incremental_tickets	Returns the tickets that changed since the start time. For more information, see Exporting tickets/documentation/ticketing/managing-tickets/using-the-incremental-export-api exporting-tickets in Using the Incremental Exports API/documentation/ticketing/managing-tickets/using-the-incremental-export-api. This endpoint supports time-based incremental exports. For more information, see Time-based incremental exports/documentation/ticketing/managing-tickets/using-the-incremental-export-api time-based	No parameters
get_api_v2_incremental_tickets_cursor	Returns the tickets that changed since the start time. For more information, see Exporting tickets/documentation/ticketing/managing-tickets/using-the-incremental-export-api exporting-tickets in Using the Incremental Exports API/documentation/ticketing/managing-tickets/using-the-incremental-export-api. This endpoint supports cursor-based incremental exports. Cursor-based exports are highly encouraged because they provide more consistent performance and response body sizes. For more information,	No parameters
get_api_v2_incremental_users	Allowed For Admins Sideloading See Users sideloads/documentation/ticketing/using-the-zendesk-api/side_loading/ supported-endpoints.	No parameters
get_api_v2_incremental_users_cursor	Allowed For Admins Sideloading See Users sideloads/documentation/ticketing/using-the-zendesk-api/side_loading/ supported-endpoints.	No parameters
get_api_v2_job_statuses	Shows the statuses for background jobs. Statuses are sorted first by completion date and then by creation date in descending order. Allowed For: Agents Pagination Cursor pagination See Pagination/api-reference/introduction/pagination/.	No parameters
get_api_v2_job_statuses_by_job_status_id	Shows the status of a background job. Allowed For: Agents	job_status_id (string)
get_api_v2_job_statuses_show_many	Accepts a comma-separated list of job status ids. Allowed For: Agents	ids (string) required
get_api_v2_locales	Lists the translation locales available for the account. Note: You can alter the list by passing an updated locale_ids array to the Update Account Settings/api-reference/ticketing/account-configuration/account_settings/ update-account-settings endpoint. Allowed For Anyone	No parameters
get_api_v2_locales_by_locale_id	Allowed For Anyone	locale_id (string)
get_api_v2_locales_agent	Lists the translation locales that have been localized for agents on a specific account. Allowed For Anyone	No parameters
get_api_v2_locales_current	This works like Show Locale show-locale, but instead of taking a locale id as an argument, it renders the locale of the user performing the request. Allowed For Anyone	No parameters
get_api_v2_locales_detect_best_locale	Allowed For Anyone	No parameters
get_api_v2_locales_public	Lists the translation locales that are available to all accounts. Allowed For Anyone	No parameters
get_api_v2_macros	Lists all shared and personal macros available to the current user. For admins, the API returns all macros for the account, including the personal macros of agents and other admins. Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents	include (string) access (string) active (boolean) category (integer) group_id (integer) only_viewable (boolean) sort_by (string) sort_order (string)
post_api_v2_macros	Allowed For Agents	data: { . macro (object) } (object) required
get_api_v2_macros_by_macro_id	Allowed For Agents	macro_id (string)
put_api_v2_macros_by_macro_id	Allowed For Agents	macro_id (string) data: { . macro (object) } (object) required
delete_api_v2_macros_by_macro_id	Allowed For Agents, with restrictions applying on certain actions	macro_id (string)
get_api_v2_macros_by_macro_id_apply	Returns the changes the macro would make to a ticket. It doesn't actually change a ticket. You can use the response data in a subsequent API call to the Tickets/api-reference/ticketing/tickets/tickets/ endpoint to update the ticket. The response includes only the ticket fields that would be changed by the macro. To get the full ticket object after the macro is applied, see Show Ticket After Changes show-ticket-after-changes. Allowed For Agents	macro_id (string)
get_api_v2_macros_by_macro_id_attachments	Lists the attachments associated with a macro. Allowed For Agents	macro_id (string)
post_api_v2_macros_by_macro_id_attachments	Allows an attachment to be uploaded and associated with a macro at the same time. Note: A macro can be associated with up to five attachments. Allowed For Agents	macro_id (string)
get_api_v2_macros_actions	Allowed For Agents	No parameters
get_api_v2_macros_active	Lists all active shared and personal macros available to the current user. Allowed For Agents	include (string) access (string) category (integer) group_id (integer) sort_by (string) sort_order (string)
post_api_v2_macros_attachments	Allows an attachment to be uploaded that can be associated with a macro at a later time. Note: To ensure an uploaded attachment is not lost, associate it with a macro as soon as possible. From time to time, old attachments that are not not associated with any macro are purged. Allowed For Agents	No parameters
get_api_v2_macros_attachments_by_attachment_id	Shows the properties of the specified macro attachment. Allowed For Agents	attachment_id (string)
get_api_v2_macros_categories	Lists all macro categories available to the current user. Allowed For Agents	No parameters
get_api_v2_macros_definitions	Returns the definitions of the actions a macro can perform. For example, one action can set the status of a ticket. The definition of the action includes a title 'Status', a type 'list', and possible values. For a list of support actions, see Actions reference/documentation/ticketing/reference-guides/actions-reference. Allowed For Agents	No parameters
delete_api_v2_macros_destroy_many	Deletes the macros corresponding to the provided comma-separated list of IDs. Allowed For Agents	ids (array) required
get_api_v2_macros_new	Returns an unpersisted macro representation derived from a ticket or macro. The endpoint takes one of the following query parameters: macro_id or ticket_id. If you include both, macro_id is used. Allowed For Agents	No parameters
get_api_v2_macros_search	Pagination Offset pagination only See Using Offset Pagination/api-reference/introduction/pagination/ using-offset-pagination. Allowed For Agents	No parameters
put_api_v2_macros_update_many	Updates the provided macros with the specified changes. Allowed For Agents	data: { . macros (array) } (object) required
get_api_v2_oauth_clients	Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Admins	No parameters
post_api_v2_oauth_clients	Allowed For Admins	No parameters
get_api_v2_oauth_clients_by_oauth_client_id	Allowed for Admins	oauth_client_id (string)
put_api_v2_oauth_clients_by_oauth_client_id	Allowed for Admins	oauth_client_id (string)
delete_api_v2_oauth_clients_by_oauth_client_id	Allowed for Admins	oauth_client_id (string)
put_api_v2_oauth_clients_by_oauth_client_id_generate_secret	Allowed for Admins	oauth_client_id (string)
get_api_v2_oauth_global_clients	Returns all the global OAuth clients that users on your account have authorized. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Admins	No parameters
get_api_v2_oauth_global_clients_by_global_client_id	Returns the global OAuth client associated with the ID sent on the request. Allowed for Admins	global_client_id (string)
get_api_v2_oauth_global_clients_token_summary	Returns information about tokens for the global clients that your account has authorized. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Admins	No parameters
get_api_v2_oauth_tokens	Returns the properties of the tokens for the current user. Admins can view OAuth token properties for all users using the all/api-reference/ticketing/oauth/oauth_tokens/ parameters parameter. The client_id/api-reference/ticketing/oauth/oauth_tokens/ parameters parameter can be included to filter that list by a global or local OAuth client ID. For security reasons, only the first 10 characters of each access token are included. Pagination Cursor pagination recommended Offset pagination	No parameters
post_api_v2_oauth_tokens	Returns an OAuth access token with a specified scope scopes. Refresh tokens aren't used. An access token doesn't expire but it can be revoked revoke-token. For a tutorial, see Creating and using OAuth tokens with the API/documentation/ticketing/working-with-oauth/creating-and-using-oauth-tokens-with-the-api/. Note: For OAuth authorization code, use the Create Token for Grant Type/api-reference/ticketing/oauth/grant_type_tokens/ create-token-for-grant-type endpoint. The two APIs don't share th	No parameters
get_api_v2_oauth_tokens_by_oauth_token_id	Returns the properties of the specified token. For security reasons, only the first 10 characters of the access token are included. In the first endpoint, id is a token id, not the full token. In the second endpoint, include an Authorization: Bearer header with the full token to get its associated properties. Example: sh curl https://subdomain.zendesk.com/api/v2/oauth/tokens/current.json -H 'Authorization: Bearer $authToken' -v -u email_address/token:api_token Allowed for Admin	oauth_token_id (string)
delete_api_v2_oauth_tokens_by_oauth_token_id	Allowed for Admins, Agents, End Users	oauth_token_id (string)
get_api_v2_object_layouts_by_object_type_essentials_card	Gets the essentials card for an object type. Allowed For Admins and agents	object_type (string)
put_api_v2_object_layouts_by_object_type_essentials_card	Updates the essentials card for an object type. Allowed For Admins	object_type (string)
delete_api_v2_object_layouts_by_object_type_essentials_card	Delete the essentials card for an object type. Allowed For Admins and agents	object_type (string)
get_api_v2_object_layouts_essentials_cards	Gets the list of essentials cards. Allowed For Admins	No parameters
get_api_v2_organization_fields	Returns a list of custom organization fields in your account. Fields are returned in the order that you specify in your organization fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each organization field to the values returned under the organization_fields attribute on the organization/api-reference/ticketing/organizations/organizations/ resource. Pagination Cursor pagination recommended Offset paginati	No parameters
post_api_v2_organization_fields	Creates any of the following custom field types: text default when no 'type' is specified textarea checkbox date integer decimal regexp dropdown lookup multiselect See About custom field typeshttps://support.zendesk.com/hc/en-us/articles/203661866 in Zendesk help. Allowed For Admins	No parameters
get_api_v2_organization_fields_by_organization_field_id	Allowed for Agents	organization_field_id (string)
put_api_v2_organization_fields_by_organization_field_id	Updating a Dropdown Tagger or Multiselect Field Dropdown and multiselect fields return an array of custom_field_options which specify the name, value, and order of dropdown or multiselect options. When updating a dropdown or multiselect field, note the following information: - All options must be passed on update. Options that are not passed will be removed. As a result, these values will be removed from any organizations - To create a new option, pass a null id along with the name and va	organization_field_id (string)
delete_api_v2_organization_fields_by_organization_field_id	Allowed for Admins	organization_field_id (string)
put_api_v2_organization_fields_reorder	Allowed For Admins	No parameters
get_api_v2_organization_memberships	Returns a list of organization memberships for the account, user or organization in question. Note: When returning organization memberships for a user, organization memberships are sorted with the default organization first, and then by organization name. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For - Agents - End users	No parameters
post_api_v2_organization_memberships	Assigns a user to a given organization. Returns an error with status 422 if the user is already assigned to the organization. Allowed For Admins Agents when creating a new organization membership for an end user	No parameters
get_api_v2_organization_memberships_by_organization_membership_id	Allowed for Agents	organization_membership_id (string)
delete_api_v2_organization_memberships_by_organization_membership_id	Immediately removes a user from an organization and schedules a job to unassign all working tickets currently assigned to the user and organization combination. The organization_id of the unassigned tickets is set to null. Allowed for Admins Agents when deleting an organization membership for an end user	organization_membership_id (string)
post_api_v2_organization_memberships_create_many	Accepts an array of up to 100 organization membership objects. This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-management/job_statuses/ json-format and queues a background job to do the work. Use the Show Job Status/api-reference/ticketing/ticket-management/job_statuses/ show-job-status endpoint to check for the job's completion. Only a certain number of jobs can be queued or running at the same time. See Job limit/api-reference/introduction/rate-limits/ job-limit	No parameters
delete_api_v2_organization_memberships_destroy_many	Immediately removes a user from an organization and schedules a job to unassign all working tickets currently assigned to the user and organization combination. The organization_id of the unassigned tickets is set to null. Response This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-management/job_statuses/ json-format and queues a background job to do the work. Use the Show Job Status/api-reference/ticketing/ticket-management/job_statuses/ show-job-status endpoi	ids (array)
get_api_v2_organization_merges_by_organization_merge_id	Retrieves the details of a specific organization merge operation. This endpoint is useful for obtaining the status and outcome of a merge that was previously initiated. It provides information such as the winning and losing organization IDs, the status of the merge, and the associated URLs. This endpoint can be used to determine if a merge is still in progress, has completed successfully, or has encountered an error. Allowed For Admins	organization_merge_id (string)
get_api_v2_organization_subscriptions	Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For: Agents End users For end users, the response will only list the subscriptions created by the requesting end user.	No parameters
post_api_v2_organization_subscriptions	Allowed For: Agents End users End users can only subscribe to shared organizations in which they're members.	data: { . organization_subscription } (object) required
get_api_v2_organization_subscriptions_by_organization_subscription_id	Allowed For: Agents End users For end users, the response will only list the subscriptions created by the requesting end user.	organization_subscription_id (integer)
delete_api_v2_organization_subscriptions_by_organization_subscription_id	Allowed For: Agents End users	organization_subscription_id (integer)
get_api_v2_organizations	Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents, with certain restrictions If the agent has a custom agent role that restricts their access to only users in their own organization, a 403 Forbidden error is returned. See Creating custom agent roleshttps://support.zendesk.com/hc/en-us/articles/203662026-Creating-custom-roles-and-assigning-agents topic_c	No parameters
post_api_v2_organizations	You must provide a unique name for each organization. Normally the system doesn't allow records to be created with identical names. However, a race condition can occur if you make two or more identical POSTs very close to each other, causing the records to have identical organization names. Note: Leading and trailing whitespace in name is automatically trimmed before validation. This means that names differing only by whitespace are treated as duplicates. For example, 'API Company' and 'API Com	data: { . organization } (object) required
get_api_v2_organizations_by_organization_id	Allowed For Admins Agents	organization_id (string)
put_api_v2_organizations_by_organization_id	Allowed For Admins Agents Agents with no permissions restrictions can only update 'notes' on organizations. Note: Updating an organization's domain_names property overwrites all existing domain_names values. To prevent this, submit a complete list of domain_names for the organization in your request. Example Request 'organization': 'notes': 'Something interesting'	organization_id (string)
delete_api_v2_organizations_by_organization_id	Allowed For Admins Agents assigned to a custom role with permissions to manage organizations Enterprise only	organization_id (string)
post_api_v2_organizations_by_organization_id_merge	Merges two organizations by moving all users, tickets, and domain names from the organization specified by organization_id to the organization specified by winner_id. After the merge: - The 'losing' organization will be deleted. - Other organization fields and their values will not be carried over to the 'winning' organization. - The merge operation creates an Organization Merge record which contains a status indicating the progress of the merge. Note: This operation is irreversible. Mer	organization_id (string) data: { . organization_merge (object) } (object) required
get_api_v2_organizations_by_organization_id_merges	Retrieves a list of all organization merge operations associated with a given organization. This endpoint allows you to track the history of merge actions for an organization, including ongoing and completed merges. Each entry in the list contains details such as the ID of the merge, the winning and losing organization IDs, the current status of the merge, and a URL to access the Organization Merge record. Pagination - Cursor pagination is used for this endpoint. - A maximum of 100 recor	organization_id (string)
get_api_v2_organizations_by_organization_id_related	Allowed For Agents	organization_id (string)
get_api_v2_organizations_autocomplete	Returns an array of organizations whose name starts with the value specified in the name parameter. Pagination Offset pagination only See Using Offset Pagination/api-reference/introduction/pagination/ using-offset-pagination. Allowed For Agents	No parameters
get_api_v2_organizations_count	Returns an approximate count of organizations. If the count exceeds 100,000, it is updated every 24 hours. The refreshed_at property of the count object is a timestamp that indicates when the count was last updated. When the count exceeds 100,000, the refreshed_at property may occasionally be null. This indicates that the count is being updated in the background and the value property of the count object is limited to 100,000 until the update is complete. Allowed For Agents	No parameters
post_api_v2_organizations_create_many	Accepts an array of up to 100 organization objects. Response This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-management/job_statuses/ json-format and queues a background job to do the work. Use the Show Job Status/api-reference/ticketing/ticket-management/job_statuses/ show-job-status endpoint to check for the job's completion. Only a certain number of jobs can be queued or running at the same time. See Job limit/api-reference/introduction/rate-limits/ job-li	No parameters
post_api_v2_organizations_create_or_update	Creates an organization if it doesn't already exist, or updates an existing organization. Using this method means one less call to check if an organization exists before creating it. You need to specify the id or external id when updating an organization to avoid a duplicate error response. Name is not available as a matching criteria. Allowed For Agents, with restrictions on certain actions	No parameters
delete_api_v2_organizations_destroy_many	Accepts a comma-separated list of up to 100 organization ids or external ids. Response This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-management/job_statuses/ json-format and queues a background job to do the work. Use the Show Job Status/api-reference/ticketing/ticket-management/job_statuses/ show-job-status endpoint to check for the job's completion. Only a certain number of jobs can be queued or running at the same time. See Job limit/api-reference/introd	No parameters
get_api_v2_organizations_search	Returns an array of organizations matching the criteria. You may search by an organization's external_id or name, but not both: Searching by external_id If you set the external_id value of an organization to associate it to an external record, you can use it to search for the organization. For an organization to be returned, its external_id must exactly match the value provided case insensitive. Searching by name For an organization to be returned, its name must exactly match the	No parameters
get_api_v2_organizations_show_many	Accepts a comma-separated list of up to 100 organization ids or external ids. Allowed For Admins Agents	No parameters
put_api_v2_organizations_update_many	Bulk or batch updates up to 100 organizations. Bulk update To make the same change to multiple organizations, use the following endpoint and data format: https://subdomain.zendesk.com/api/v2/organizations/update_many.json?ids=1,2,3 'organization': 'notes': 'Priority' Batch update To make different changes to multiple organizations, use the following endpoint and data format: https://subdomain.zendesk.com/api/v2/organizations/update_many.json 'organizations': 'id	No parameters
get_api_v2_problems	The response is always ordered by updated_at in descending order Allowed For Agents Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/.	No parameters
post_api_v2_problems_autocomplete	Returns tickets whose type is 'problem' and whose subject contains the string specified in the text parameter. You can specify the text parameter in the request body rather than the query string. Example: 'text': 'fire' Allowed For Agents	text (string) data: { . text (string) } (object) required
post_api_v2_push_notification_devices_destroy_many	Unregisters the mobile devices that are receiving push notifications. Specify the devices as an array of mobile device tokens. Allowed for Admins	data: { . push_notification_devices } (object) required
get_api_v2_queues	Returns all active queues for an account. Allowed For Admins	No parameters
post_api_v2_queues	Creates a queue. Accepts a JSON queue definition as the request body. Allowed For Admins	No parameters
get_api_v2_queues_by_queue_id	Returns a queue for the given queue id. Allowed For Agents	queue_id (string)
put_api_v2_queues_by_queue_id	Updates the queue definition for a given queue id. Allowed For Admins	queue_id (string)
delete_api_v2_queues_by_queue_id	Deletes the queue and related records. Allowed For Admins	queue_id (string)
get_api_v2_queues_definitions	Returns the definitions of the queues and the definitions of the conditions under which a queue can execute. The definition of the action includes a title 'Status', a type 'list', and possible values. The definition of the condition includes the same fields as well as the possible operators. Allowed For Admins	No parameters
patch_api_v2_queues_order	Alters the evaluation order of OCR queues in the account. The evaluation order is set in a queue_ids array in the request body. You must include every queue id in your account to reorder the OCR queues. If not, the endpoint will return 400 Bad Request. Allowed For Admins	No parameters
get_api_v2_recipient_addresses	Lists all the support addresses for the account. Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Admins Agents	No parameters
post_api_v2_recipient_addresses	Adds a Zendesk or external support address to your account. To add a Zendesk address, use the following syntax: local-part@accountname.zendesk.com. Example: 'sales-team@example.zendesk.com'. The local-parthttps://en.wikipedia.org/wiki/Email_address Local-part can be anything you like. To add an external email address such as help@omniwearshop.com, the email must already exist and you must set up forwarding on your email server. The exact steps depend on your mail server. See Forwarding incomin	No parameters
get_api_v2_recipient_addresses_by_support_address_id	Allowed For Admins Agents	support_address_id (string)
put_api_v2_recipient_addresses_by_support_address_id	Updates an existing support address for your account. You can't use this endpoint to update a support address's email property. Instead, you can create a new address using the Create Support Address create-support-address endpoint. Allowed For Admins Agents with permission to manage channels and extensions. See the system permissions in Creating custom roles and assigning agents Enterprisehttps://support.zendesk.com/hc/en-us/articles/203662026-Creating-custom-roles-and-assigning-agents	support_address_id (string)
delete_api_v2_recipient_addresses_by_support_address_id	Deletes a support address. Allowed For Admins Agents with permission to manage channels and extensions. See the system permissions in Creating custom roles and assigning agents Enterprisehttps://support.zendesk.com/hc/en-us/articles/203662026-Creating-custom-roles-and-assigning-agents-Enterprise- topic_cxn_hig_bd in the Support Help Center	support_address_id (string)
put_api_v2_recipient_addresses_by_support_address_id_verify	Sends a test email to the specified support address to verify that email forwarding for the address works. An external support address won't work in Zendesk Support until it's verified. Note: You don't need to verify Zendesk system support addresses. The endpoint takes the following body: 'type': 'forwarding'. The value of the type property defaults to 'forwarding' if none is specified, but the values 'spf' and 'dns' are also accepted. Use this endpoint after adding create-support-address an	support_address_id (string)
get_api_v2_relationships_definitions_by_target_type	Returns filter definitions based on the given target type. Target types include users zen:user, tickets zen:ticket, organizations zen:organization, or custom objects zen:custom_object:CUSTOM_OBJECT_KEY. The returned filter definitions are the options that you can use to build a custom field or ticket field's relationship_filter.	target_type (string) source_type (string)
get_api_v2_requests	Allowed for End Users Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/.	sort_by (string) sort_order (string)
post_api_v2_requests	Accepts a request object that sets one or more properties. Allowed for End users Anonymous users rate limit of 5 requests per hour for trial accounts/documentation/developer-tools/getting-started/getting-a-trial-or-sponsored-account-for-development/ Additional properties In addition to the writable request properties in the JSON Format table json-format above, you can set the following properties when creating a request. | Name | Type | Mandatory | Comment | ---	No parameters
get_api_v2_requests_by_request_id	Sideloads The following sideloads are supported: | Name | Will sideload | ---------------- | ------------- | users | The email ccs for a request by side-loading users Allowed For End Users	request_id (string)
put_api_v2_requests_by_request_id	Updates a request with a comment or collaborators cc's. The end user who created the request can also use it to mark the request as solved. The endpoint can't be used to update other request attributes. Writable properties This endpoint can only update the following properties in the request. | Name | Type | Required | Description | | ------------------------ | ------- | -------- | --------------------------------------------	request_id (string)
get_api_v2_requests_by_request_id_comments	Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Sorting By default, comments are sorted by creation date in ascending order. When using cursor pagination, use the following parameter to change the sort order: | Name | Type | Required | Comments | ------ | ------ | -------- | -------- | sort | string | no | Possible values are 'created_at' ascending order or '-created_at' descending order When using o	request_id (string) since (string) role (string)
get_api_v2_requests_by_request_id_comments_by_ticket_comment_id	Allowed For End Users	request_id (string) ticket_comment_id (string)
get_api_v2_requests_search	Examples: GET /api/v2/requests/search.json?query=printer GET /api/v2/requests/search.json?query=printer and organization_id=1 GET /api/v2/requests/search.json?query=printer and cc_id=true GET /api/v2/requests/search.json?query=printer and status=hold,open Pagination Offset pagination only See Using Offset Pagination/api-reference/introduction/pagination/ using-offset-pagination. Results limit The Search Requests endpoint returns up to 1,000 results per query, with a maximum	query (string)
get_api_v2_resource_collections	Lists resource collections for the account. Allowed for Admins	No parameters
post_api_v2_resource_collections	Creates a resource collection from a provided payload object. The payload object is specified the same way as the content of a requirements.json file in a Zendesk app. See Specifying Apps Requirements/documentation/apps/app-developer-guide/apps_requirements/ in the Zendesk Apps framework docs. The response includes a job status/api-reference/ticketing/ticket-management/job_statuses/ for creation of the specified resources. Allowed for Admins	No parameters
get_api_v2_resource_collections_by_resource_collection_id	Retrieves details for a specified resource collection. Allowed for Admins	resource_collection_id (string)
put_api_v2_resource_collections_by_resource_collection_id	Updates a resource collection using a provided payload object. The payload object is specified the same way as the content of a requirements.json file in a Zendesk app. See Specifying Apps Requirements/documentation/apps/app-developer-guide/apps_requirements/ in the Zendesk Apps framework docs. The response includes a job status/api-reference/ticketing/ticket-management/job_statuses/ for the resource updates. Allowed for Admins	resource_collection_id (string)
delete_api_v2_resource_collections_by_resource_collection_id	Deletes a specified resource collection. The response includes a job status/api-reference/ticketing/ticket-management/job_statuses/ for deletion of the collection's resources. Allowed for Admins	resource_collection_id (string)
get_api_v2_routing_agents_by_user_id_instance_values	Returns an attribute value. Allowed For Agents and admins	user_id (string)
post_api_v2_routing_agents_by_user_id_instance_values	Adds the specified attributes if no attributes exists, or replaces all existing attributes with the specified attributes. Allowed For Admins	user_id (string)
get_api_v2_routing_agents_instance_values	Accepts a comma-separated list of up to 100 agent ids and returns attribute values for each agent in the list. Allowed For Admins Agents in custom role with permission to manage skillshttps://support.zendesk.com/hc/en-us/articles/4408882153882-Creating-custom-roles-and-assigning-agents Pagination Cursor pagination/api-reference/introduction/pagination/ cursor-pagination only. Note: pagebefore and pageafter can't be used together in the same request.	filteragent_ids (string) required pagebefore (string) pageafter (string) pagesize (integer)
post_api_v2_routing_agents_instance_values_job	Adds, replaces or removes multiple attributes for up to 100 agents. Allowed For Admins Agents in custom role with permission to manage skillshttps://support.zendesk.com/hc/en-us/articles/4408882153882-Creating-custom-roles-and-assigning-agents Available Parameters The request takes a data object with the following properties: | Name | Type | Required | Description | | ---------- | ------	data: { . job } (object) required
get_api_v2_routing_attributes	Returns a list of attributes for the account. Sideloads The following sideloads are supported: | Name | Will sideload | ---------------- | ------------- | attribute_values | The attribute values available on the account Allowed For Agents and admins	No parameters
post_api_v2_routing_attributes	Creates an attribute. Allowed For Agents	No parameters
get_api_v2_routing_attributes_by_attribute_id	Returns an attribute. Allowed For Admins	attribute_id (string)
put_api_v2_routing_attributes_by_attribute_id	Updates an attribute. Allowed For Admins	attribute_id (string)
delete_api_v2_routing_attributes_by_attribute_id	Deletes an attribute. Allowed For Admins	attribute_id (string)
get_api_v2_routing_attributes_by_attribute_id_values	Returns a list of attribute values for a provided attribute. Allowed For Agents	attribute_id (string)
post_api_v2_routing_attributes_by_attribute_id_values	Creates an attribute value. Allowed For Admins	attribute_id (string)
get_api_v2_routing_attributes_by_attribute_id_values_by_attribute_value_id	Returns an attribute value. Allowed For Agents	attribute_id (string) attribute_value_id (string)
patch_api_v2_routing_attributes_by_attribute_id_values_by_attribute_value_id	Updates the name and ticket conditions of a skill. When a ticket is created, the skill is applied to a ticket if the ticket meets the specified condition or conditions. See the Conditions reference/documentation/ticketing/reference-guides/conditions-reference/ for more information. Allowed For Admins	attribute_id (string) attribute_value_id (string)
delete_api_v2_routing_attributes_by_attribute_id_values_by_attribute_value_id	Deletes an attribute value. Allowed For Agents	attribute_id (string) attribute_value_id (string)
get_api_v2_routing_attributes_definitions	Returns the condition definitions that can be configured to apply attributes to a ticket. Allowed For Admins	No parameters
get_api_v2_routing_requirements_fulfilled	Returns a list of ticket ids that contain attributes matching the current user's attributes. Accepts a ticket_ids parameter for relevant tickets to check for matching attributes. Allowed For Agents and admins	ticket_ids (integer) required
get_api_v2_routing_tickets_by_ticket_id_instance_values	Returns a list of attributes values for the ticket. Allowed For Agents and admins	ticket_id (string)
post_api_v2_routing_tickets_by_ticket_id_instance_values	Adds the specified attributes if no attributes exists, or replaces all existing attributes with the specified attributes. Invalid or deleted attributes are ignored. Allowed For Admins	ticket_id (string)
get_api_v2_satisfaction_ratings	Allowed For Admins Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Filters | Parameter | Value | ---------- | ----- | score | offered, unoffered, received, received_with_comment, received_without_comment,br/good, good_with_comment, good_without_comment,br/bad, bad_with_comment, bad_without_comment | start_time | Time of the oldest satisfaction rating, as a Unix epoch timehttps://www.epochconverter.com/	No parameters
get_api_v2_satisfaction_ratings_by_satisfaction_rating_id	Returns a specific satisfaction rating. You can get the id from the List Satisfaction Ratings list-satisfaction-ratings endpoint. Allowed For Admins	satisfaction_rating_id (integer)
get_api_v2_satisfaction_ratings_count	Returns an approximate count of satisfaction ratings in the account. If the count exceeds 100,000, the count will return a cached result. This cached result will update every 24 hours. The countrefreshed_at property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, countrefreshed_at may occasionally be null. This indicates that the count is being updated in the background, and countvalue is limited to 100,000 until the update is complete.	No parameters
get_api_v2_satisfaction_reasons	List all reasons for an account Allowed For Admins	No parameters
get_api_v2_satisfaction_reasons_by_satisfaction_reason_id	Allowed For Admins	satisfaction_reason_id (integer)
get_api_v2_search	Returns the search results. See Query basics query-basics for the syntax of the query parameter. Use the ampersand character and to append the sort_by or sort_order parameters to the URL. For examples, see Searching with Zendesk API/documentation/ticketing/using-the-zendesk-api/searching-with-the-zendesk-api. Allowed For Agents Pagination Offset pagination only Offset pagination may result in duplicate results when paging. You can also use the Export Search Results/api-refer	query (string) required sort_by (string) sort_order (string)
get_api_v2_search_count	Returns the number of items matching the query rather than the items. The search string works the same as a regular search. Allowed For - Agents	query (string) required
get_api_v2_search_export	Exports a set of results. See Query syntax query-syntax for the syntax of the query parameter. Use this endpoint for search queries that will return more than 1000 results. The result set is ordered only by the created_at attribute. The search only returns results of a single object type. The following object types are supported: ticket, organization, user, or group. You must specify the type in the filtertype parameter. Searches with type in the query string will result in an error. Al	query (string) required pagesize (integer) filtertype (string)
get_api_v2_sessions	If authenticated as an admin, returns all the account's sessions. If authenticated as an agent or end user, returns only the sessions of the user making the request. Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Allowed For Admins, Agents, End users	No parameters
get_api_v2_sharing_agreements	Allowed For Agents	No parameters
post_api_v2_sharing_agreements	Allowed For Admins	No parameters
get_api_v2_sharing_agreements_by_sharing_agreement_id	Returns a sharing agreement for your account. Allowed For Agents	sharing_agreement_id (string)
put_api_v2_sharing_agreements_by_sharing_agreement_id	Returns an updated sharing agreement. Only status is allowed to be updated. Allowed For Admins	sharing_agreement_id (string)
delete_api_v2_sharing_agreements_by_sharing_agreement_id	Deletes a sharing agreement. Allowed For Admins	sharing_agreement_id (string)
post_api_v2_skips	Record a new ticket skip for the current user. Allowed For Agents	No parameters
get_api_v2_slas_policies	Availability Accounts on the Support Professional or Suite Growth plan or above Allowed For Admins	No parameters
post_api_v2_slas_policies	Availability Accounts on the Support Professional or Suite Growth plan or above Allowed For Admins	No parameters
get_api_v2_slas_policies_by_sla_policy_id	Availability Accounts on the Support Professional or Suite Growth plan or above Allowed For Admins	sla_policy_id (string)
put_api_v2_slas_policies_by_sla_policy_id	Updates the specified policy. Availability Accounts on the Support Professional or Suite Growth plan or above Allowed For Admins	sla_policy_id (string)
delete_api_v2_slas_policies_by_sla_policy_id	Availability Accounts on the Support Professional or Suite Growth plan or above Allowed For Admins	sla_policy_id (string)
get_api_v2_slas_policies_definitions	Availability Accounts on the Support Professional or Suite Growth plan or above Allowed For Admins	No parameters
put_api_v2_slas_policies_reorder	Availability Accounts on the Support Professional or Suite Growth plan or above Allowed For Admins	sla_policy_ids (array)
get_api_v2_suspended_tickets	Allowed For Admins and agents in custom roles with permissionhttps://support.zendesk.com/hc/en-us/articles/4408882153882 topic_cxn_hig_bd to manage suspended tickets on Enterprise plans Unrestricted agents on all other plans Sorting You can sort the tickets with the sort_by and sort_order query string parameters. Pagination Cursor pagination See Pagination/api-reference/introduction/pagination/.	No parameters
get_api_v2_suspended_tickets_by_id	Allowed For Admins and agents in custom roles with permissionhttps://support.zendesk.com/hc/en-us/articles/4408882153882 topic_cxn_hig_bd to manage suspended tickets on Enterprise plans Unrestricted agents on all other plans	id (number)
delete_api_v2_suspended_tickets_by_id	Allowed For Unrestricted agents	id (number)
put_api_v2_suspended_tickets_by_id_recover	Note: During recovery, the API sets the requester to the authenticated agent who called the API, not the original requester. This prevents the ticket from being re-suspended after recovery. To preserve the original requester, use the Recover Multiple Suspended Tickets recover-multiple-suspended-tickets endpoint with the single ticket. This endpoint does not queue an asynchronous job that can be tracked from Job Statuses/api-reference/ticketing/ticket-management/job_statuses/. Instead, it proces	id (number)
post_api_v2_suspended_tickets_attachments	Makes copies of any attachments on a suspended ticket and returns them as attachment tokens/api-reference/ticketing/tickets/ticket-attachments/. If the ticket is manually recovered, you can include the attachment tokens on the new ticket. Allowed For Admins and agents in custom roles with permissionhttps://support.zendesk.com/hc/en-us/articles/4408882153882 topic_cxn_hig_bd to manage suspended tickets on Enterprise plans Unrestricted agents on all other plans	No parameters
delete_api_v2_suspended_tickets_destroy_many	Accepts up to 100 ids the auto-generated id, not the ticket id. Allowed For Admins and agents in custom roles with permissionhttps://support.zendesk.com/hc/en-us/articles/4408882153882 topic_cxn_hig_bd to manage suspended tickets on Enterprise plans Unrestricted agents on all other plans	No parameters
post_api_v2_suspended_tickets_export	Exports a list of suspended tickets for the Zendesk Support instance. To export the list, the endpoint enqueues a job to create a CSV file with the data. When done, Zendesk sends the requester an email containing a link to the CSV file. In the CSV, tickets are sorted by the update timestamp in ascending order. Allowed For Admins and agents in custom roles with permissionhttps://support.zendesk.com/hc/en-us/articles/4408882153882 topic_cxn_hig_bd to manage suspended tickets on Enterpris	No parameters
put_api_v2_suspended_tickets_recover_many	Accepts up to 100 ids the auto-generated id, not the ticket id. Note that suspended tickets that fail to be recovered are still included in the response. Allowed For Admins and agents in custom roles with permissionhttps://support.zendesk.com/hc/en-us/articles/4408882153882 topic_cxn_hig_bd to manage suspended tickets on Enterprise plans Unrestricted agents on all other plans	No parameters
get_api_v2_tags	Lists up to the 20,000 most popular tags in the last 60 days, in decreasing popularity. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents	No parameters
get_api_v2_tags_count	Returns an approximate count of tags. If the count exceeds 100,000, it is updated every 24 hours. The refreshed_at property of the count object is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, the refreshed_at property in the count object may occasionally be null. This indicates that the count is being updated in the background and the value property in the count object is limited to 100,000 until the update is complete. Allowed For A	No parameters
get_api_v2_target_failures	Returns the 25 most recent target failures, per target. Stability Development Allowed For Admins	No parameters
get_api_v2_target_failures_by_target_failure_id	Stability Development Allowed For Admins	target_failure_id (string)
get_api_v2_targets	Allowed For Agents	No parameters
post_api_v2_targets	Allowed For Admins	No parameters
get_api_v2_targets_by_target_id	Allowed For Agents	target_id (string)
put_api_v2_targets_by_target_id	Allowed For Admins	target_id (string)
delete_api_v2_targets_by_target_id	Allowed For Admins	target_id (string)
get_api_v2_ticket_audits	Returns ticket audits. Archived tickets are not included in the response. Use the List Audits for a Ticket list-audits-for-a-ticket endpoint to retrieve audit records for an archived ticket. To learn more about archived tickets, see About archived ticketshttps://support.zendesk.com/hc/en-us/articles/203657756. This endpoint should not be used for capturing change data. When continually chasing the tail of a cursor, some records will be skipped. For this use case, use the Incremental Ticket Even	pagebefore (string) pageafter (string) pagesize (integer)
get_api_v2_ticket_content_pins	Lists the content pins for a specific ticket. Content pins are used to pin related content such as articles to a ticket for quick access. This endpoint returns the content pins associated with the specified ticket id. Allowed For Agents	ticket_id (string)
post_api_v2_ticket_content_pins	Creates a new content pin for a specific ticket. Content pins allow you to link to articles, community posts, or external content for easy reference. Allowed For Admins Agents	data: { . ticket_content_pin (object) } (object) required
delete_api_v2_ticket_content_pins_by_content_pin_id	Deletes a specific content pin from a ticket. Allowed For Agents	content_pin_id (string)
get_api_v2_ticket_fields	Returns a list of all system and custom ticket fields in your account. For end users, only the ticket fields with visible_in_portal set to true are returned. Cursor pagination returns a maximum of 100 records per page and fields are returned in the order specified by their id. If the results are not paginated, every field is returned in the response and fields are returned in the order specified by the position. You can adjust the position of ticket fields by: - Using the Update Ticket Fiel	locale (string) creator (boolean)
post_api_v2_ticket_fields	Creates any of the following custom field types: | Custom field type | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| | text | Default custom field type when type is not specified	No parameters
get_api_v2_ticket_fields_by_ticket_field_id	Allowed for Agents Sideloads The following sideloads are supported: | Name | Will sideload | ---------------- | ------------- | users | The user or users that created the ticket field	ticket_field_id (string)
put_api_v2_ticket_fields_by_ticket_field_id	Updating drop-down field options You can also use the update endpoint to add, update, or remove options in a drop-down custom field. Updating field options for multi-select fields works exactly the same as drop-down field options. Important: Unless you want to remove some options, you must specify all existing options in any update request. Omitting an option removes it from the drop-down field, which removes its values from any tickets or macros. Use the custom_field_options attribute t	ticket_field_id (string)
delete_api_v2_ticket_fields_by_ticket_field_id	Allowed for Admins	ticket_field_id (string)
get_api_v2_ticket_fields_by_ticket_field_id_options	Returns a list of custom ticket field options for the given drop-down ticket field. Allowed For Agents Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/.	ticket_field_id (string)
post_api_v2_ticket_fields_by_ticket_field_id_options	Creates or updates an option for the given drop-down ticket field. To update an option, include the id of the option in the custom_field_option object. Example: 'custom_field_option': 'id': 10002, 'name': 'Pineapples', ... If an option exists for the given ID, the option will be updated. Otherwise, a new option will be created. Response Returns one of the following status codes: - 200 with Location: /api/v2/ticket_fields/ticket_field_id/options.json if the ticket field option already	ticket_field_id (string)
get_api_v2_ticket_fields_by_ticket_field_id_options_by_ticket_field_option_id	Allowed for Agents	ticket_field_id (string) ticket_field_option_id (string)
delete_api_v2_ticket_fields_by_ticket_field_id_options_by_ticket_field_option_id	Allowed for Admins	ticket_field_id (string) ticket_field_option_id (string)
get_api_v2_ticket_fields_count	Returns an approximate count of system and custom ticket fields in the account. If the count exceeds 100,000, the count will return a cached result. This cached result will update every 24 hours. The countrefreshed_at property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, countrefreshed_at may occasionally be null. This indicates that the count is being updated in the background, and countvalue is limited to 100,000 until the update is co	No parameters
put_api_v2_ticket_fields_reorder	Allowed For Admins Request Parameters You can pass in the following parameter in the payload: | Name | Type | Comment | ------------------- | ------ | -------- | ticket_field_ids | array | An array of ticket field ids. Example: '2, 23, 46, 50'. Not all ticket_field_ids are necessary in the payload; only those provided will be assigned to the first positions. Missing IDs will be assigned incremental positions automatically.	No parameters
get_api_v2_ticket_form_statuses	Fetches all of the ticket form statuses for the account. Allowed For Admins Agents	No parameters
get_api_v2_ticket_form_statuses_show_many	Fetches all of the ticket form statuses specified by a comma separated list of ids. Allowed For Admins Agents	ids (string) required
get_api_v2_ticket_forms	Returns a list of all ticket forms for your account if accessed as an admin or agent. End users only see ticket forms that have end_user_visible set to true. Allowed For Anyone	active (boolean) end_user_visible (boolean) fallback_to_default (boolean) associated_to_brand (boolean)
post_api_v2_ticket_forms	Allowed For Admins	No parameters
get_api_v2_ticket_forms_by_ticket_form_id	Allowed For Admins, Agents, and End Users	ticket_form_id (string)
put_api_v2_ticket_forms_by_ticket_form_id	Allowed For Admins	ticket_form_id (string)
delete_api_v2_ticket_forms_by_ticket_form_id	Allowed For Admins	ticket_form_id (string)
post_api_v2_ticket_forms_by_ticket_form_id_clone	Allowed For Admins	ticket_form_id (string)
get_api_v2_ticket_forms_by_ticket_form_id_ticket_form_statuses	Fetches all of the associated ticket form statuses of a ticket form. Allowed For Admins Agents	ticket_form_id (string)
post_api_v2_ticket_forms_by_ticket_form_id_ticket_form_statuses	Creates one or many ticket form status associations Allowed For Admins	ticket_form_id (string) data: { . ticket_form_status (array) } (object) required
put_api_v2_ticket_forms_by_ticket_form_id_ticket_form_statuses	Updates or deletes ticket form status associations. This is a bulk operation that can both add and remove ticket form status associations for a form in one call. Allowed For Admins	ticket_form_id (string) data: { . ticket_form_status (array) } (object) required
delete_api_v2_ticket_forms_by_ticket_form_id_ticket_form_statuses	Deletes all of of the ticket form statuses by id. Allowed For Admins Agents	ticket_form_id (string) data: { . id (array) } (object) required
put_api_v2_ticket_forms_by_ticket_form_id_ticket_form_statuses_by_ticket_form_status_id	Updates or deletes ticket form status association by id. Allowed For Admins	ticket_form_id (string) ticket_form_status_id (string) data: { . ticket_form_status (array) } (object) required
delete_api_v2_ticket_forms_by_ticket_form_id_ticket_form_statuses_by_ticket_form_status_id	Deletes a ticket form status by id. Allowed For Admins	ticket_form_id (string) ticket_form_status_id (string)
put_api_v2_ticket_forms_reorder	Allowed For Admins Request Parameters You can pass in the following parameter in the payload: | Name | Type | Comment | ------------------- | ------ | -------- | ticket_form_ids | array | An array of ticket form ids. Example: '2, 23, 46, 50'	No parameters
get_api_v2_ticket_forms_show_many	Takes an ids query parameter that accepts a comma-separated list of up to 100 ticket form ids. This endpoint is used primarily by the mobile SDK/documentation/classic-web-widget-sdks/ and the Web Widget/api-reference/widget/introduction/. Allowed For Anyone	ids (string) required active (boolean) end_user_visible (boolean) fallback_to_default (boolean) associated_to_brand (boolean)
get_api_v2_ticket_metrics	Returns a list of tickets with their metrics. Tickets are ordered chronologically by created date, from newest to oldest. The last ticket listed may not be the absolute oldest ticket in your account due to ticket archiving. Archived tickets are not included in the response. See About archived ticketshttps://support.zendesk.com/hc/en-us/articles/203657756 in Zendesk help. Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/	No parameters
get_api_v2_ticket_metrics_by_ticket_metric_id	Returns a specific metric, or the metrics of a specific ticket. Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents	ticket_metric_id (string)
get_api_v2_tickets	List Tickets	external_id (string)
post_api_v2_tickets	Create Ticket	data: { . ticket } (object) required
get_api_v2_tickets_by_ticket_id	Returns a number of ticket properties though not the ticket comments. To get the comments, use List Comments/api-reference/ticketing/tickets/ticket_comments/ list-comments Allowed For Agents	ticket_id (integer)
put_api_v2_tickets_by_ticket_id	Update Ticket	ticket_id (integer) data: { . ticket } (object) required
delete_api_v2_tickets_by_ticket_id	Allowed For Admins Agents with permission to delete tickets Agent delete permissions are set in Support. See Deleting ticketshttps://support.zendesk.com/hc/en-us/articles/203690936 in the Support Help Center. Ticket deletion rate limit You can delete 400 tickets every 1 minute using this endpoint. The rate limiting mechanism behaves as described in Rate limits/api-reference/introduction/rate-limits/ in the API introduction. Zendesk recommends that you obey the Retry-After header	ticket_id (integer)
get_api_v2_tickets_by_ticket_id_audits	Lists the audits for a specified ticket. Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Note: Audits for Archived Ticketshttps://support.zendesk.com/hc/en-us/articles/4408887617050 do not support pagination for this endpoint. Allowed for Agents	ticket_id (string)
get_api_v2_tickets_by_ticket_id_audits_by_ticket_audit_id	Allowed for Agents	ticket_id (string) ticket_audit_id (string)
put_api_v2_tickets_by_ticket_id_audits_by_ticket_audit_id_make_private	Allowed for Agents	ticket_id (string) ticket_audit_id (string)
get_api_v2_tickets_by_ticket_id_audits_count	Returns an approximate count of audits for a specified ticket. If the count exceeds 100,000, the count will return a cached result. This cached result will update every 24 hours. The countrefreshed_at property is a timestamp that indicates when the count was last updated. Note: If the total number of audits for a ticket exceeds 100,000, this endpoint returns a count of 100,000 with a countrefreshed_at value of null. This value is cached for 24 hours, during which any requests returns the same	ticket_id (string)
get_api_v2_tickets_by_ticket_id_collaborators	Allowed For Agents	ticket_id (integer)
get_api_v2_tickets_by_ticket_id_comments	Returns the comments added to the ticket. Each comment may include a content_url for an attachment or a recording_url for a voice comment that points to a file that may be hosted externally. For security reasons, take care not to inadvertently send Zendesk authentication credentials to third parties when attempting to access these files. See Working with url properties/documentation/ticketing/managing-tickets/working-with-url-properties. Pagination - Cursor pagination recommended - Offse	ticket_id (string) include_inline_images (boolean) include (string)
put_api_v2_tickets_by_ticket_id_comments_by_comment_id_attachments_by_attachment_id_redact	Redaction allows you to permanently remove attachments from an existing comment on a ticket. Once removed from a comment, the attachment is replaced with an empty 'redacted.txt' file. The redaction is permanent. It is not possible to undo redaction or see what was removed. Once a ticket is closed, redacting its attachments is no longer possible. Also, if you want to redact an inline attachment, you can use the include_inline_images parameter in the List Comments/api-reference/ticketing/tickets	ticket_id (string) comment_id (string) attachment_id (string)
put_api_v2_tickets_by_ticket_id_comments_by_ticket_comment_id_make_private	Allowed For Agents	ticket_id (string) ticket_comment_id (string)
put_api_v2_tickets_by_ticket_id_comments_by_ticket_comment_id_redact	Permanently removes words or strings from a ticket comment. Specify the string to redact in an object with a text property. Example: ''text': '987-65-4320''. The characters of the word or string are replaced by the ▇ symbol. If the comment was made by email, the endpoint also attempts to redact the string from the original email retained by Zendesk for audit purposes. Note: If you use the rich text editor, support for redacting formatted text bold, italics, hyperlinks is limited. Redaction is	ticket_id (string) ticket_comment_id (string)
get_api_v2_tickets_by_ticket_id_comments_count	Returns an approximate count of the comments added to the ticket. If the count exceeds 100,000, the count will return a cached result. This cached result will update every 24 hours. The countrefreshed_at property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, countrefreshed_at may occasionally be null. This indicates that the count is being updated in the background, and countvalue is limited to 100,000 until the update is complete.	ticket_id (integer)
get_api_v2_tickets_by_ticket_id_conversation_log	Lists the conversation log events for a specified ticket. Pagination - Cursor pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed for Agents	ticket_id (integer)
get_api_v2_tickets_by_ticket_id_email_ccs	Returns any users cc'd on the ticket. Availability The CCs and Followershttps://support.zendesk.com/hc/en-us/articles/203690846 feature must be enabled in Zendesk Support. If the feature is not enabled, the default CC functionality is used. In that case, use List Collaborators/api-reference/ticketing/tickets/tickets/ list-collaborators-for-a-ticket to list the users cc'ed on the ticket. Allowed For Agents	ticket_id (integer)
get_api_v2_tickets_by_ticket_id_followers	Returns any users who follow the ticket. Availability The CCs and Followershttps://support.zendesk.com/hc/en-us/articles/203690846 feature must be enabled in Zendesk Support. Allowed For Agents	ticket_id (integer)
get_api_v2_tickets_by_ticket_id_incidents	Allowed For Agents Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/.	ticket_id (integer)
get_api_v2_tickets_by_ticket_id_macros_by_macro_id_apply	Returns the full ticket object as it would be after applying the macro to the ticket. It doesn't actually change the ticket. To get only the ticket fields that would be changed by the macro, see Show Changes to Ticket show-changes-to-ticket. Allowed For Agents	ticket_id (string) macro_id (string)
put_api_v2_tickets_by_ticket_id_mark_as_spam	Allowed For Agents	ticket_id (integer)
post_api_v2_tickets_by_ticket_id_merge	Merges one or more tickets into the ticket with the specified id. See Merging ticketshttps://support.zendesk.com/hc/en-us/articles/203690916 in the Support Help Center for ticket merging rules. Any attachment to the source ticket is copied to the target ticket. This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-management/job_statuses/ json-format and queues a background job to do the work. Use the Show Job Status/api-reference/ticketing/ticket-management/job_status	ticket_id (integer) data: { . ids (array) . source_comment (string) . source_comment_is_public (boolean) . target_comment (string) . target_comment_is_public (boolean) } (object) required
get_api_v2_tickets_by_ticket_id_related	The request returns a data object with the following properties: | Name | Type | Comment | ------------------- | ------- | ------- | topic_id | string | Related topic in the Web portal deprecated feature | jira_issue_ids | array | Array of associated jira issues | followup_source_ids | array | Sources to follow up | from_archive | boolean | Is true if the current ticket is archived | incidents | integer | A count of related incident occurr	ticket_id (integer)
post_api_v2_tickets_by_ticket_id_satisfaction_rating	Creates a CSAT rating for a solved ticket, or for a ticket that was previously solved and then reopened. Only the end user listed as the ticket requester can create a satisfaction rating for the ticket. Only 'good' and 'bad' are valid values for the score when creating a rating. Other states, like 'offered', are not valid and will result in a 422 error. Allowed For End user who requested the ticket The end user must be a verified user.	ticket_id (string)
get_api_v2_tickets_by_ticket_id_tags	Allowed For Agents	ticket_id (string)
post_api_v2_tickets_by_ticket_id_tags	Allowed For Agents	ticket_id (string)
put_api_v2_tickets_by_ticket_id_tags	You can also add tags to multiple tickets with the Update Many Tickets/api-reference/ticketing/tickets/tickets/ update-many-tickets endpoint. Safe Update If the same ticket is updated by multiple API requests at the same time, some tags could be lost because of ticket update collisions. Include updated_stamp and safe_update properties in the request body to make a safe update. For updated_stamp, retrieve and specify the ticket's latest updated_at timestamp. The tag update only occurs if	ticket_id (string)
delete_api_v2_tickets_by_ticket_id_tags	You can also delete tags from multiple tickets with the Update Many Tickets/api-reference/ticketing/tickets/tickets/ update-many-tickets endpoint. This endpoint supports safe updates. See Safe Update/api-reference/ticketing/ticket-management/tags/ safe-update. Allowed For Agents	ticket_id (string)
get_api_v2_tickets_count	Returns an approximate count of tickets in the account. If the count exceeds 100,000, it is updated every 24 hours. ccd lists tickets that the specified user is cc'd on. The countrefreshed_at property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, countrefreshed_at may occasionally be null. This indicates that the count is being updated in the background, and countvalue is limited to 100,000 until the update is complete. Allowed For	No parameters
post_api_v2_tickets_create_many	Accepts an array of up to 100 ticket objects. Note: Every ticket created with this endpoint may be affected by your business rules, which can include sending email notifications to your end users. If you are importing historical tickets or creating more than 1000 tickets, consider using the Ticket Bulk Import/api-reference/ticketing/tickets/ticket_import/ ticket-bulk-import endpoint. This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-management/job_statuses/ json-form	data: { . tickets (array) } (object) required
delete_api_v2_tickets_destroy_many	Accepts a comma-separated list of up to 100 ticket ids. Allowed For Admins Agents with permission to delete tickets Agent delete permissions are set in Support. See Deleting ticketshttps://support.zendesk.com/hc/en-us/articles/203690936 in the Support Help Center. This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-management/job_statuses/ json-format and queues a background job to do the work. Use the Show Job Status/api-reference/ticketing/ticket-management	ids (string) required
put_api_v2_tickets_mark_many_as_spam	Accepts a comma-separated list of up to 100 ticket ids. This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-management/job_statuses/ json-format and queues a background job to do the work. Use the Show Job Status/api-reference/ticketing/ticket-management/job_statuses/ show-job-status endpoint to check for the job's completion. Only a certain number of jobs can be queued or running at the same time. See Job limit/api-reference/introduction/rate-limits/ job-limit for mor	ids (string) required
get_api_v2_tickets_show_many	Accepts a comma-separated list of ticket ids to return. This endpoint will return up to 100 tickets records. Allowed For Agents	ids (string) required
put_api_v2_tickets_update_many	Accepts an array of up to 100 ticket objects, or a comma-separated list of up to 100 ticket ids.	ids (string)
get_api_v2_trigger_categories	Returns all the ticket trigger categories in the account. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/.	page: { . after (string) . before (string) . size (integer) } (object) sort (string) include (string)
post_api_v2_trigger_categories	Creates a ticket trigger category.	data: { . trigger_category } (object) required
get_api_v2_trigger_categories_by_trigger_category_id	Returns the ticket trigger category with the specified ID.	trigger_category_id (string)
patch_api_v2_trigger_categories_by_trigger_category_id	Updates the ticket trigger category with the specified ID.	trigger_category_id (string) data: { . trigger_category (object) } (object) required
delete_api_v2_trigger_categories_by_trigger_category_id	Deletes the ticket trigger category with the specified ID.	trigger_category_id (string)
post_api_v2_trigger_categories_jobs	Creates a job that performs a batch operation for the given ticket trigger categories.	data: { . job (object) } (object) required
get_api_v2_triggers	Lists all ticket triggers for the current account. Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents Sideloads The following sideloads are supported. The usage sideloads are only supported on the Support Professional or Suite Growth plan or above. | Name | Will sideload | ---------------- | ------------- | app_installation | The ap	active (boolean) sort (string) sort_by (string) sort_order (string) category_id (string)
post_api_v2_triggers	Allowed For Agents	data: { . trigger } (object) required
get_api_v2_triggers_by_trigger_id	Allowed For Agents The Via Type value is a number instead of a text string. See Via types reference/documentation/ticketing/reference-guides/via-types/ for the keys.	trigger_id (string)
put_api_v2_triggers_by_trigger_id	Allowed For Agents Note Updating a condition or action updates both the conditions and actions arrays, clearing all existing values of both arrays. Include all your conditions and actions when updating any condition or action.	trigger_id (string) data: { . trigger } (object) required
delete_api_v2_triggers_by_trigger_id	Allowed For Agents	trigger_id (string)
get_api_v2_triggers_by_trigger_id_revisions	List the revisions associated with a ticket trigger. Ticket trigger revision history is only available on Enterprise plans. Allowed For Agents Sideloads The following sideloads are supported: | Name | Will sideload | ----- | ------------- | users | The user that authored each revision Pagination This endpoint uses cursor-based pagination. The records are ordered in descending order by the created_at timestamp, then by id on duplicate created_at values. The cursor parame	trigger_id (string)
get_api_v2_triggers_by_trigger_id_revisions_by_trigger_revision_id	Fetches a revision associated with a ticket trigger. Ticket trigger revision history is only available on Enterprise plans. Allowed For Agents Sideloads The following sideloads are supported: | Name | Will sideload | ----- | ------------- | users | The user that authored each revision	trigger_id (string) trigger_revision_id (string)
get_api_v2_triggers_active	Lists all active ticket triggers. Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents Sideloads The following sideloads are supported: | Name | Will sideload | ---------------- | ------------- | app_installation | The app installation that requires each ticket trigger, if present | permissions | The permissions for each trigger |	No parameters
get_api_v2_triggers_definitions	Returns the definitions of the actions a ticket trigger can perform and the definitions of the conditions under which a ticket trigger can execute. The definition of the action includes a title 'Status', a type 'list', and possible values. The definition of the condition includes the same fields as well as the possible operators. For a list of supported actions, see the Actions reference/documentation/ticketing/reference-guides/actions-reference For a list of supported conditions, see the Condi	No parameters
delete_api_v2_triggers_destroy_many	Deletes the ticket triggers corresponding to the provided comma-separated list of IDs. Allowed For Agents Request Parameters The DELETE request takes one parameter, an ids object that lists the ticket triggers to delete. | Name | Description | ---- | ----------- | ids | The IDs of the triggers to delete Example request 'ids': '25,23,27,22'	No parameters
put_api_v2_triggers_reorder	Alters the firing order of ticket triggers in the account. See Reordering and sorting triggershttps://support.zendesk.com/hc/en-us/articles/115015696088 in the Zendesk Help Center. The firing order is set in a trigger_ids array in the request body. You must include every ticket trigger id in your account to reorder the ticket triggers. If not, the endpoint will return 404 Forbidden. Reordering ticket triggers via the API is not permitted if you have more than one ticket trigger category. If th	No parameters
get_api_v2_triggers_search	Pagination Offset pagination only See Using Offset Pagination/api-reference/introduction/pagination/ using-offset-pagination. Allowed For Agents Sideloads The following sideloads are supported. For more information, see Side-loading/documentation/ticketing/using-the-zendesk-api/side_loading/. | Name | Will sideload | ---------------- | ------------- | app_installation | The app installation that requires each ticket trigger, if present | permissions | The	No parameters
put_api_v2_triggers_update_many	Updates the position or the active status of multiple ticket triggers. Any additional properties are ignored. Allowed For Agents Request Parameters The PUT request expects a triggers object that lists the ticket triggers to update. Each ticket trigger may have the following properties: | Name | Mandatory | Description | -------- | --------- | ----------- | id | yes | The ID of the ticket trigger to update | position | no | The new position of t	data: { . triggers (array) } (object) required
post_api_v2_uploads	Uploads a file that can be attached to a ticket comment. It doesn't attach the file to the comment. For details and examples, see Attaching ticket comments with the API/documentation/ticketing/managing-tickets/adding-ticket-attachments-with-the-api/. The endpoint has a required filename query parameter. The parameter specifies what the file will be named when attached to the ticket comment to give the agent more context about the file. The parameter does not specify the file on the local system	No parameters
delete_api_v2_uploads_by_token	Allowed for End Users	token (string)
get_api_v2_user_fields	Returns a list of custom user fields in your account. Fields are returned in the order that you specify in your user fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each User Field to the values returned under the user_fields attribute on the User/api-reference/ticketing/users/users/ resource. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination	No parameters
post_api_v2_user_fields	Creates any of the following custom field types: text default when no 'type' is specified textarea checkbox date integer decimal regexp dropdown lookup multiselect See About custom field typeshttps://support.zendesk.com/hc/en-us/articles/203661866 in Zendesk help. Allowed For Admins	No parameters
get_api_v2_user_fields_by_user_field_id	Allowed for Agents	user_field_id (string)
put_api_v2_user_fields_by_user_field_id	Updating a Dropdown Tagger or Multiselect Field Dropdown and multiselect fields return an array of custom_field_options which specify the name, value, and order of the list of dropdown or multiselect options. Understand the following behavior when updating a dropdown or multiselect field: - All options must be passed on update. Options that are not passed will be removed. As a result, these values will be removed from any organizations. - To create a new option, pass a null id along with	user_field_id (string)
delete_api_v2_user_fields_by_user_field_id	Allowed for Admins	user_field_id (string)
get_api_v2_user_fields_by_user_field_id_options	Returns a list of custom user field options for the given dropdown user field. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents	user_field_id (string)
post_api_v2_user_fields_by_user_field_id_options	Creates a new option or updates an existing option for the given drop-down user field. To update an option, include the id of the option in the custom_field_option object. Example: 'custom_field_option': 'id': 10002, 'name': 'Pineapples', ... . If an option exists for the given ID, the option will be updated. Otherwise, a new option will be created. Response Returns one of the following status codes: - 200 with Location: /api/v2/user_fields/user_field_id/options.json if the user field o	user_field_id (string)
get_api_v2_user_fields_by_user_field_id_options_by_user_field_option_id	Allowed for Agents	user_field_id (string) user_field_option_id (string)
delete_api_v2_user_fields_by_user_field_id_options_by_user_field_option_id	Allowed for Admins	user_field_id (string) user_field_option_id (string)
put_api_v2_user_fields_reorder	Allowed For Admins	No parameters
get_api_v2_users	Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Admins, Agents and Light Agents	role (string) role (string) permission_set (integer) external_id (string)
post_api_v2_users	Create User	data: { . user } (object) required
get_api_v2_users_by_user_id	Allowed For Agents	user_id (string)
put_api_v2_users_by_user_id	Update User	user_id (string) data: { . user } (object) required
delete_api_v2_users_by_user_id	Deletes the user and associated records from the account. Warning: Deleted users are not recoverable. Both agents and administrators can soft delete users in the agent interface in Zendesk Support. Agents with permission can delete end users, while administrators can delete all users except the account owner. To comply with GDPR, a further step is needed. See Permanently Delete User/api-reference/ticketing/users/users/ permanently-delete-user. Allowed For Admins and agents in custom	user_id (string)
get_api_v2_users_by_user_id_compliance_deletion_statuses	Returns the GDPR status for each user per area of compliance. A Zendesk area of compliance is typically a product like 'support/explore' but can be more fine-grained for areas within the product lines. If the user is not in the account, the request returns a 404 status. http Status: 404 'error':'RecordNotFound', 'description':'Not found' Allowed For Agents, with restrictions Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introdu	user_id (string) application (string)
put_api_v2_users_by_user_id_group_memberships_by_group_membership_id_make_default	Allowed For: Agents	user_id (string) group_membership_id (string)
get_api_v2_users_by_user_id_identities	Returns a list of identities for the given user. Use the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only list email and phone number identities. Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page for cursor pagination. Allowed For Agents Verified end users	user_id (string)
post_api_v2_users_by_user_id_identities	Adds an identity to a user's profile. An agent can add an identity to any user profile. Supported identity types: | Type | Example | | ---------------- | ------- | | email | 'type' : 'email', 'value' : 'someone@example.com' | | twitter | 'type' : 'twitter', 'value' : 'screen_name' | | facebook | 'type' : 'facebook', 'value' : '855769377321' | | google | 'type' : 'google', 'value' : 'example@gmail.com' | | agent_forwarding | 'type' : 'a	user_id (string)
get_api_v2_users_by_user_id_identities_by_user_identity_id	Shows the identity with the given id for a given user. Use the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only view email or phone number identity. Allowed For Agents Verified end users	user_id (string) user_identity_id (string)
put_api_v2_users_by_user_id_identities_by_user_identity_id	This endpoint allows you to: Set the specified identity as verified by setting verified to 'true' or verification_method to 'low' Unverify a verified identity by setting verified to 'false' or verification_method to 'none' Update the value property of the specified identity You can't change an identity's primary attribute with this endpoint. You must use the Make Identity Primary make-identity-primary endpoint instead. Allowed For Agents	user_id (string) user_identity_id (string)
delete_api_v2_users_by_user_id_identities_by_user_identity_id	Deletes the identity for a given user. In certain cases, a phone number associated with an identity is still visible on the user profile after the identity has been deleted via API. You can remove the phone number from the user profile by updating the phone attribute of the user to an empty string. See Update User via API/api-reference/ticketing/users/users/ update-user for details and examples. Deleting identities with type messaging could break messaging functionality. For example, an agent m	user_id (string) user_identity_id (string)
put_api_v2_users_by_user_id_identities_by_user_identity_id_make_primary	Sets the specified identity as primary. To change other attributes, use the Update Identity update-identity endpoint. This is a collection-level operation and the correct behavior for an API client is to subsequently reload the entire collection. The first endpoint is the preferred option if authenticating as an agent. If authenticating as an end user, you can only use the second endpoint. In addition, an end user can only make an email identity primary if the email is verified. Allowed	user_id (string) user_identity_id (string)
put_api_v2_users_by_user_id_identities_by_user_identity_id_request_verification	Sends the user a verification email with a link to verify ownership of the email address. Allowed For Agents	user_id (string) user_identity_id (string)
put_api_v2_users_by_user_id_identities_by_user_identity_id_verify	Sets the specified identity as verified. For security reasons, you can't use this endpoint to update the email identity of the account owner. To verify the person's identity, send a verification email. See Verifying the account owner's email addresshttps://support.zendesk.com/hc/en-us/articles/4408828975130 in Zendesk help. If automatic mapping of users to organizations using the email domainhttps://support.zendesk.com/hc/en-us/articles/4408882246298-Creating-organizations topic_nxl_vdt_bc is	user_id (string) user_identity_id (string)
put_api_v2_users_by_user_id_merge	Merges the end user specified in the path parameter into the existing end user specified in the request body. Any two end users can be merged with the exception of end users created by sharing agreements. To be eligible for merging, the user in the path parameter must be a requester on 10,000 or fewer tickets. Otherwise, the merge will be blocked. Agents, admins, and users with more than 10,000 requested tickets cannot be merged. For more information about how user data is merged, see Mergin	user_id (string) data: { . user } (object) required
put_api_v2_users_by_user_id_organization_memberships_by_organization_membership_id_make_default	Sets the default organization membership of a given user. Allowed for Admins Agents when setting the default organization membership for an end user	user_id (string) organization_membership_id (string)
delete_api_v2_users_by_user_id_organizations_by_organization_id	Immediately removes a user from an organization and schedules a job to unassign all working tickets currently assigned to the user and organization combination. The organization_id of the unassigned tickets is set to null. Allowed For Agents	user_id (string) organization_id (string)
put_api_v2_users_by_user_id_organizations_by_organization_id_make_default	Sets the default organization membership of a given user. Allowed For Agents	user_id (string) organization_id (string)
post_api_v2_users_by_user_id_password	An admin can set a user's password only if the setting is enabled in Zendesk Support under Settings Security Global. The setting is off by default. Only the account owner can access and change this setting. Allowed For Admins	user_id (string)
put_api_v2_users_by_user_id_password	You can only change your own password. Nobody can change the password of another user because it requires knowing the user's existing password. However, an admin can set a new password for another user without knowing the existing password. See Set a User's Password set-a-users-password above. Allowed For Agents End Users	user_id (string)
get_api_v2_users_by_user_id_password_requirements	Allowed For Agents End Users	user_id (string)
get_api_v2_users_by_user_id_related	Show User Related Information	user_id (string)
delete_api_v2_users_by_user_id_sessions	Deletes all the sessions for a user. Allowed For Admins, Agents, End users	user_id (string)
get_api_v2_users_by_user_id_sessions_by_session_id	Allowed For Admins, Agents, End users	user_id (string) session_id (string)
delete_api_v2_users_by_user_id_sessions_by_session_id	Allowed For Admins, Agents, End users	user_id (string) session_id (string)
get_api_v2_users_by_user_id_skips	Archived tickets are not included in the response. See About archived ticketshttps://support.zendesk.com/hc/en-us/articles/203657756 in the Support Help Center. Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents with 'View only' or higher reports permissions in Support. These permissions are distinct from Explore permissions. Agents retrieving their	user_id (string)
get_api_v2_users_autocomplete	Returns an array of users whose name starts with the value specified in the name parameter. It only returns users with no foreign identities. Allowed For Agents	name (string) required field_id (string) source (string)
get_api_v2_users_count	Returns an approximate count of users. If the count exceeds 100,000, it is updated every 24 hours. The response includes a refreshed_at property in a count object that contains a timestamp indicating when the count was last updated. Note: When the count exceeds 100,000, the refreshed_at property may occasionally be null. This indicates that the count is being updated in the background. The count object's value property is limited to 100,000 until the update is complete. Allowed For Adm	role (string) role (string) permission_set (integer)
post_api_v2_users_create_many	Accepts an array of up to 100 user objects. Note: To protect the data in your Zendesk account, bulk user imports are not enabled by default in Zendesk accounts. The account owner must contact Zendesk Customer Supporthttps://support.zendesk.com/hc/en-us/articles/4408843597850 to enable the imports. A 403 Forbidden error is returned if data imports are not enabled. Allowed For Admins and agents in custom roles with permissionhttps://support.zendesk.com/hc/en-us/articles/4408882153882 topi	data: { . users (array) } (object) required
post_api_v2_users_create_or_update	Creates a user if the user does not already exist, or updates an existing user identified by e-mail address or external ID. If you don't specify a role parameter, the new user is assigned the role of end user. If you need to create users without sending out a verification email, include a 'skip_verify_email': true property in the body. External ID Case Sensitivity When providing an external id to identify an existing user to update, the search for the user record is not case sensitive.	data: { . user } (object) required
post_api_v2_users_create_or_update_many	Accepts an array of up to 100 user objects. For each user, the user is created if it does not already exist, or the existing user is updated. Note: To protect the data in your Zendesk account, bulk user imports are not enabled by default in Zendesk accounts. The account owner must contact Zendesk Customer Supporthttps://support.zendesk.com/hc/en-us/articles/4408843597850 to enable the imports. A 403 Forbidden error is returned if data imports are not enabled. Each individual user object can id	data: { . users (array) } (object) required
delete_api_v2_users_destroy_many	Accepts a comma-separated list of up to 100 user ids. The request takes an ids or an external_ids query parameter. Allowed for Admins Response This endpoint returns a job_status JSON object/api-reference/ticketing/ticket-management/job_statuses/ json-format and queues a background job to do the work. Use the Show Job Status/api-reference/ticketing/ticket-management/job_statuses/ show-job-status endpoint to check for the job's completion. Only a certain number of jobs can be queue	ids (string) external_ids (string)
post_api_v2_users_logout_many	Accepts a comma-separated list of up to 100 user ids. Allowed For: Admins	ids (string)
get_api_v2_users_me	The endpoint returns user information/api-reference/ticketing/users/users/ and an authenticity_token. Allowed For Anonymous users Authenticity Token Zendesk API calls made by end users from a Zendesk help center must include authenticity_token in the X-CSRF-Token HTTP header. This helps prevent cross-site request forgery CSRFhttps://en.wikipedia.org/wiki/Cross-site_request_forgery attacks. For an example using an authenticity token, see the AJAX request in the Upgrading from Temp	No parameters
delete_api_v2_users_me_logout	Deletes the current session. In practice, this only works when using session auth for requests, such as client-side requests made from a Zendesk app. When using OAuth or basic authentication, you don't have a current session so this endpoint has no effect. Allowed For Admins, Agents, End users	No parameters
get_api_v2_users_me_session	Allowed For Admins, Agents, End users	No parameters
get_api_v2_users_me_session_renew	Allowed For Admins, Agents, End users	No parameters
post_api_v2_users_request_create	Sends the owner a reminder email to update their subscription so more agents can be created. Allowed For Agents	data: { . user } (object) required
get_api_v2_users_search	Returns an array of users who meet the search criteria. Returns up to 100 records per page to a maximum of 10,000 records per query. See Using offset pagination/api-reference/introduction/pagination/ using-offset-pagination. Pagination Offset pagination only See Using Offset Pagination/api-reference/introduction/pagination/ using-offset-pagination. Allowed For Agents	query (string) external_id (string)
get_api_v2_users_show_many	Accepts a comma-separated list of up to 100 user ids or external ids. Allowed For: Agents	ids (string) external_ids (string) include_deleted (boolean)
put_api_v2_users_update_many	Update Many Users	ids (string) external_ids (string) data (undefined) required
get_api_v2_views	Lists shared and personal views available to the current user. Sideloads The following sideloads are supported: | Name | Will sideload | ---------------- | ------------- | app_installation | The app installation that requires each view, if present | permissions | The permissions for each view Pagination - Cursor pagination recommended - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allow	access (string) active (boolean) group_id (integer) sort (string) sort_by (string) sort_order (string)
post_api_v2_views	Allowed For Agents JSON Format The JSON format consists of one property, a view object that lists the values to set when the view is created. Note: The request must include at least one condition in the all array that checks one of the following fields: status, type, group_id, assignee_id, or requester_id. | Name | Description | ----------- | ----------- | title | Required. The title of the view | all | Required. An array of one or more conditions. A ticket m	No parameters
get_api_v2_views_by_view_id	Allowed For Agents	view_id (string)
put_api_v2_views_by_view_id	Allowed For Agents JSON Format The PUT request takes one property, a view object that lists the values to update. All properties are optional. Note: Updating a condition updates the containing array, clearing the other conditions. Include all your conditions when updating any condition. | Name | Description | ----------- | ----------- | title | The title of the view | all | An array of one or more conditions. A ticket must meet all the conditions to be inclu	view_id (string)
delete_api_v2_views_by_view_id	Allowed For Agents	view_id (string)
get_api_v2_views_by_view_id_count	Returns the ticket count for a single view. This endpoint is rate limited to 5 requests per minute, per view, per agent. View Counts The view count endpoints, Count Tickets in View this endpoint and Count Tickets in Views count-tickets-in-views, let you estimate how many tickets remain in a view without having to retrieve the entire view. They're designed to help estimate view size. From a business perspective, accuracy becomes less relevant as view size increases. To ensure quality of	view_id (string)
get_api_v2_views_by_view_id_execute	Returns the column titles and the rows of the specified view. The columns array lists the view's column titles and includes only views parameters. The rows array lists the values of each column for each ticket and includes parameters from both views and tickets. Though not displayed in the view, a partial ticket object is included with each row object. Note: To get the full ticket objects for a specified view, use List Tickets from a View list-tickets-from-a-view. This endpoint is rate limit	view_id (string) sort_by (string) sort_order (string)
get_api_v2_views_by_view_id_export	Returns the csv attachment of the specified view if possible. Enqueues a job to produce the csv if necessary. Allowed For Agents	view_id (string)
get_api_v2_views_by_view_id_tickets	Allowed For Agents Pagination Cursor pagination recommended Offset pagination See Pagination/api-reference/introduction/pagination/.	view_id (string) sort_by (string) sort_order (string)
get_api_v2_views_active	Lists active shared and personal views available to the current user. Sideloads The following sideloads are supported: | Name | Will sideload | ---------------- | ------------- | app_installation | The app installation that requires each view, if present | permissions | The permissions for each view Pagination - Offset pagination See Pagination/api-reference/introduction/pagination/. Returns a maximum of 100 records per page. Allowed For Agents	access (string) group_id (integer) sort_by (string) sort_order (string)
get_api_v2_views_compact	A compacted list of shared and personal views available to the current user. This endpoint never returns more than 32 records and does not respect the 'per_page' option. Allowed For Agents	No parameters
get_api_v2_views_count	Returns an approximate count of shared and personal views available to the current user. If the count exceeds 100,000, the count will return a cached result. This cached result will update every 24 hours. The countrefreshed_at property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, countrefreshed_at may occasionally be null. This indicates that the count is being updated in the background, and countvalue is limited to 100,000 until the upd	No parameters
get_api_v2_views_count_many	Returns the ticket count of each view in a list of views. Accepts up to 20 view ids per request. For the ticket count of a single view, see Count Tickets in View count-tickets-in-view. Only returns values for personal and shared views accessible to the user performing the request. This endpoint is rate limited to 6 requests every 5 minutes. Allowed For Agents	ids (string) required
delete_api_v2_views_destroy_many	Deletes the views corresponding to the provided list of IDs. Allowed For Agents	ids (string) required
post_api_v2_views_preview	You can preview views by constructing the conditions in the proper format and nesting them under the view property. See Conditions reference/documentation/ticketing/reference-guides/conditions-reference/. The output can also be controlled by passing in any of the following parameters and nesting them under the output property. | Name | Type | Comment | --------------- | ------- | ------- | columns | Array | The ticket fields to display. System fields are looked up by nam	No parameters
post_api_v2_views_preview_count	Returns the ticket count for a single preview. Allowed For Agents	No parameters
get_api_v2_views_search	Pagination Offset pagination only See Using Offset Pagination/api-reference/introduction/pagination/ using-offset-pagination. Allowed For Agents Sideloads The following sideloads are supported. For more information, see Side-loading/documentation/ticketing/using-the-zendesk-api/side_loading/. | Name | Will sideload | ---------------- | ------------- | app_installation | The app installation that requires each view, if present | permissions | The permissio	query (string) required access (string) active (boolean) group_id (integer) sort_by (string) sort_order (string) include (string)
get_api_v2_views_show_many	Allowed For Agents Sideloads The following sideloads are supported: | Name | Will sideload | ---------------- | ------------- | app_installation | The app installation that requires each view, if present | permissions | The permissions for each view	ids (string) required active (boolean)
put_api_v2_views_update_many	Allowed For Agents Request Parameters The PUT request expects a views object that lists the views to update. Each view may have the following properties: | Name | Mandatory | Description | -------- | --------- | ----------- | id | yes | The ID of the view to update | position | no | The new position of the view | active | no | The active status of the view true or false Example Request Body 'views': 'id': 25, 'position': 3, 'id': 23	No parameters
get_api_v2_workspaces	Allowed For Admins, Agents	No parameters
post_api_v2_workspaces	Allowed For Admins	data: { . workspace (object) } (object) required
get_api_v2_workspaces_by_workspace_id	Allowed For Admins	workspace_id (string)
put_api_v2_workspaces_by_workspace_id	Allowed For Admins	workspace_id (string) data: { . workspace (object) } (object) required
delete_api_v2_workspaces_by_workspace_id	Allowed For Admins	workspace_id (string)
delete_api_v2_workspaces_destroy_many	Allowed For Admins	ids (array) required
put_api_v2_workspaces_reorder	Allowed For Admins	data: { . ids (array) } (object) required
post_oauth_tokens	Returns an OAuth access token in exchange for an authorization codehttps://support.zendesk.com/hc/en-us/articles/203663836 topic_pvr_ncl_1l valid for 120 seconds. Using a Zendesk username and password to gain an OAuth access token password grant type flow has been deprecated and is highly discouraged. An access token can be revoked. Use the OAuth Tokens API/api-reference/ticketing/oauth/oauth_tokens to list, show, or revoke tokens. Request parameters The POST request takes the following	No parameters