Skip to main content
Server path: /zendesk-admin | Type: Application | PCID required: Yes

Tools

ToolDescription
zendesk_admin_create_automationCreate Automation
zendesk_admin_create_macroCreate Macro
zendesk_admin_create_triggerCreate Trigger
zendesk_admin_create_viewCreate View
zendesk_admin_delete_automationDelete Automation
zendesk_admin_delete_macroDelete Macro
zendesk_admin_delete_triggerDelete Ticket Trigger
zendesk_admin_delete_viewDelete View
zendesk_admin_execute_viewExecute View
zendesk_admin_get_automationShow Automation
zendesk_admin_get_custom_statusShow Custom Ticket Status
zendesk_admin_get_macroShow Macro
zendesk_admin_get_ticket_fieldShow Ticket Field
zendesk_admin_get_ticket_formShow Ticket Form
zendesk_admin_get_triggerShow Ticket Trigger
zendesk_admin_get_viewShow View
zendesk_admin_list_automationsList Automations
zendesk_admin_list_custom_statusesList Custom Ticket Statuses
zendesk_admin_list_macrosList Macros
zendesk_admin_list_ticket_fieldsList Ticket Fields
zendesk_admin_list_ticket_formsList Ticket Forms
zendesk_admin_list_tickets_from_viewList Tickets From a View
zendesk_admin_list_triggersList Ticket Triggers
zendesk_admin_list_viewsList Views
zendesk_admin_search_automationsSearch Automations
zendesk_admin_search_macroSearch Macros
zendesk_admin_search_macrosSearch Macros
zendesk_admin_search_triggersSearch Ticket Triggers
zendesk_admin_search_viewsSearch Views
zendesk_admin_show_changes_to_ticketShow Changes to Ticket
zendesk_admin_update_automationUpdate Automation
zendesk_admin_update_macroUpdate Macro
zendesk_admin_update_triggerUpdate Ticket Trigger
zendesk_admin_update_viewUpdate View

zendesk_admin_create_automation

Create Automation

zendesk_admin_create_macro

Create Macro Parameters:
ParameterTypeRequiredDefaultDescription
macroobjectNoThe macro value

zendesk_admin_create_trigger

Create Trigger Parameters:
ParameterTypeRequiredDefaultDescription
triggerobjectNoThe trigger value

zendesk_admin_create_view

Create View

zendesk_admin_delete_automation

Delete Automation Parameters:
ParameterTypeRequiredDefaultDescription
automation_idintegerYesThe ID of the automation

zendesk_admin_delete_macro

Delete Macro Parameters:
ParameterTypeRequiredDefaultDescription
macro_idintegerYesThe ID of the macro

zendesk_admin_delete_trigger

Delete Ticket Trigger Parameters:
ParameterTypeRequiredDefaultDescription
trigger_idintegerYesThe ID of the trigger

zendesk_admin_delete_view

Delete View Parameters:
ParameterTypeRequiredDefaultDescription
view_idintegerYesThe ID of the view

zendesk_admin_execute_view

Execute View Parameters:
ParameterTypeRequiredDefaultDescription
view_idintegerYesThe ID of the view
pageobjectNoPagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: ?page=2 (integer page number) - Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
sort_bystringNoThe ticket field used for sorting. This will either be a title or a custom field id.
sort_orderstringNoThe direction the tickets are sorted. May be one of ‘asc’ or ‘desc’
includestringNoA comma-separated list of sideloads to include in the response.
excludestringNoA comma-separated list of sideloads to exclude from the response.
group_bystringNoThe ticket field used for grouping. This will either be a title or a custom field id.

zendesk_admin_get_automation

Show Automation Parameters:
ParameterTypeRequiredDefaultDescription
automation_idintegerYesThe ID of the automation

zendesk_admin_get_custom_status

Show Custom Ticket Status Parameters:
ParameterTypeRequiredDefaultDescription
custom_status_idintegerYesThe id of the custom status

zendesk_admin_get_macro

Show Macro Parameters:
ParameterTypeRequiredDefaultDescription
macro_idintegerYesThe ID of the macro

zendesk_admin_get_ticket_field

Show Ticket Field Parameters:
ParameterTypeRequiredDefaultDescription
ticket_field_idintegerYesThe ID of the ticket field
creatorbooleanNoIf true, displays the creator_user_id and creator_app_name properties. If the ticket field is created by an app, creator_app_name is the name of the app and creator_user_id is -1. If the ticket field is not created by an app, then creator_app_name is null

zendesk_admin_get_ticket_form

Show Ticket Form Parameters:
ParameterTypeRequiredDefaultDescription
ticket_form_idintegerYesThe ID of the ticket form

zendesk_admin_get_trigger

Show Ticket Trigger Parameters:
ParameterTypeRequiredDefaultDescription
trigger_idintegerYesThe ID of the trigger

zendesk_admin_get_view

Show View Parameters:
ParameterTypeRequiredDefaultDescription
view_idintegerYesThe ID of the view
includestringNoA comma-separated list of sideloads to include in the response.

zendesk_admin_list_automations

List Automations Parameters:
ParameterTypeRequiredDefaultDescription
pageobjectNoPagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: ?page=2 (integer page number) - Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
per_pageintegerNoNumber of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
sortstringNoField to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering. Example: ?sort=name or ?sort=-created_at
activebooleanNoFilter by active automations if true or inactive automations if false
includestringNoA sideload to include in the response. See Sideloads

zendesk_admin_list_custom_statuses

List Custom Ticket Statuses Parameters:
ParameterTypeRequiredDefaultDescription
status_categoriesstringNoFilter the list of custom ticket statuses by a comma-separated list of status categories
activebooleanNoIf true, show only active custom ticket statuses. If false, show only inactive custom ticket statuses. If the filter is not used, show all custom ticket statuses
defaultbooleanNoIf true, show only default custom ticket statuses. If false, show only non-default custom ticket statuses. If the filter is not used, show all custom ticket statuses

zendesk_admin_list_macros

List Macros Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA sideload to include in the response. See Sideloads
accessstringNoFilter macros by access. Possible values are “personal”, “agents”, “shared”, or “account”. The “agents” value returns all personal macros for the account’s agents and is only available to admins.
activebooleanNoFilter by active macros if true or inactive macros if false
categoryintegerNoFilter macros by category
group_idintegerNoFilter macros by group
only_viewablebooleanNoIf true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false
sort_bystringNoPossible values are “alphabetical”, “created_at”, “updated_at”, “usage_1h”, “usage_24h”, “usage_7d”, or “usage_30d”. Defaults to alphabetical
sort_orderstringNoOne of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others
pageobjectNoPagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: ?page=2 (integer page number) - Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
per_pageintegerNoNumber of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.

zendesk_admin_list_ticket_fields

List Ticket Fields Parameters:
ParameterTypeRequiredDefaultDescription
localestringNoForces the title_in_portal property to return a dynamic content variant for the specified locale. Only accepts active locale ids. Example: locale="de".
creatorbooleanNoDisplays the creator_user_id and creator_app_name properties. If the ticket field is created by an app, creator_app_name is the name of the app and creator_user_id is -1. If the ticket field is not created by an app, creator_app_name is null
pageobjectNoCursor-based pagination parameters (JSON:API style). Supports nested parameters: - page[size] - Number of records per page (default varies by endpoint, typically 100) - page[after] - Cursor token to fetch records after this position - page[before] - Cursor token to fetch records before this position Example: ?page[size]=50&page[after]=eyJvIjoiaWQiLCJ2IjoiYVFFPSJ9
sortstringNoField to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering. Example: ?sort=name or ?sort=-created_at
include_boundary_indicatorsbooleanNoWhen true, includes has_more indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
include_item_cursorsbooleanNoWhen true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).

zendesk_admin_list_ticket_forms

List Ticket Forms Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNotrue returns active ticket forms; false returns inactive ticket forms. If not present, returns both
end_user_visiblebooleanNotrue returns ticket forms where end_user_visible; false returns ticket forms that are not end-user visible. If not present, returns both
fallback_to_defaultbooleanNotrue returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms
form_typestringNoFilter ticket forms by type. Use ‘standard’ for regular ticket forms, ‘service_catalog’ for service catalog forms, or ‘all’ to return all form types
associated_to_brandbooleanNotrue returns the ticket forms of the brand specified by the url’s subdomain
pageobjectNoPagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: ?page=2 (integer page number) - Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
per_pageintegerNoNumber of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
sortstringNoField to sort results by. Prefix with - for descending order. When used with cursor pagination, this determines the cursor ordering. Example: ?sort=name or ?sort=-created_at
include_boundary_indicatorsbooleanNoWhen true, includes has_more indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
include_item_cursorsbooleanNoWhen true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).
localestringNoLocale to use for the ticket form names. If not specified, the default locale is used.

zendesk_admin_list_tickets_from_view

List Tickets From a View Parameters:
ParameterTypeRequiredDefaultDescription
view_idintegerYesThe ID of the view
sort_bystringNoSort or group the tickets by a column in the View columns table. The subject and submitter columns are not supported
sort_orderstringNoOne of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others

zendesk_admin_list_triggers

List Ticket Triggers Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNoFilter by active triggers if true or inactive triggers if false
sortstringNoCursor-based pagination only. Possible values are “alphabetical”, “created_at”, “updated_at”, or “position”.
sort_bystringNoOffset pagination only. Possible values are “alphabetical”, “created_at”, “updated_at”, “usage_1h”, “usage_24h”, or “usage_7d”. Defaults to “position”
sort_orderstringNoOne of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others
category_idstringNoFilter triggers by category ID
pageobjectNoPagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: ?page=2 (integer page number) - Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
per_pageintegerNoNumber of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
includestringNoA sideload to include in the response. See Sideloads

zendesk_admin_list_views

List Views Parameters:
ParameterTypeRequiredDefaultDescription
accessstringNoOnly views with given access. May be “personal”, “shared”, or “account”
activebooleanNoOnly active views if true, inactive views if false
group_idintegerNoOnly views belonging to given group
sortstringNoThe sort parameter used with cursor pagination. Defaults to “created_at”. Prefix with ’-’ for descending order
sort_bystringNoThe sort_by parameter used with offset pagination. Possible values are “alphabetical”, “created_at”, or “updated_at”. Defaults to “position”
sort_orderstringNoThe sort_order parameter used with offset pagination. One of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others
pageobjectNoPagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: ?page=2 (integer page number) - Cursor: ?page[size]=50&page[after]=cursor (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
per_pageintegerNoNumber of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.

zendesk_admin_search_automations

Search Automations Parameters:
ParameterTypeRequiredDefaultDescription
querystringYesQuery string used to find all automations with matching title
activebooleanNoFilter by active automations if true or inactive automations if false
sort_bystringNoPossible values are “alphabetical”, “created_at”, “updated_at”, and “position”. If unspecified, the automations are sorted by relevance
sort_orderstringNoOne of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others
includestringNoA sideload to include in the response. See Sideloads

zendesk_admin_search_macro

Search Macros Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA sideload to include in the response. See Sideloads
accessstringNoFilter macros by access. Possible values are “personal”, “agents”, “shared”, or “account”. The “agents” value returns all personal macros for the account’s agents and is only available to admins.
activebooleanNoFilter by active macros if true or inactive macros if false
categoryintegerNoFilter macros by category
group_idintegerNoFilter macros by group
only_viewablebooleanNoIf true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false
sort_bystringNoPossible values are “alphabetical”, “created_at”, “updated_at”, or “position”. Defaults to alphabetical
sort_orderstringNoOne of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others
querystringYesQuery string used to find macros with matching titles

zendesk_admin_search_macros

Search Macros Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoA sideload to include in the response. See Sideloads
accessstringNoFilter macros by access. Possible values are “personal”, “agents”, “shared”, or “account”. The “agents” value returns all personal macros for the account’s agents and is only available to admins.
activebooleanNoFilter by active macros if true or inactive macros if false
categoryintegerNoFilter macros by category
group_idintegerNoFilter macros by group
only_viewablebooleanNoIf true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false
sort_bystringNoPossible values are “alphabetical”, “created_at”, “updated_at”, or “position”. Defaults to alphabetical
sort_orderstringNoOne of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others
querystringYesQuery string used to find macros with matching titles

zendesk_admin_search_triggers

Search Ticket Triggers Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoQuery string used to find all triggers with matching title
filterstringNoJSON-encoded trigger attribute filters for the search. See Filter. Example: {"json":{"description":"Close a ticket"}}
activebooleanNoFilter by active triggers if true or inactive triggers if false
sortstringNoCursor-based pagination only. Possible values are “alphabetical”, “created_at”, “updated_at”, or “position”.
sort_bystringNoOffset pagination only. Possible values are “alphabetical”, “created_at”, “updated_at”, “usage_1h”, “usage_24h”, or “usage_7d”. Defaults to “position”
sort_orderstringNoOne of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others
includestringNoA sideload to include in the response. See Sideloads

zendesk_admin_search_views

Search Views Parameters:
ParameterTypeRequiredDefaultDescription
querystringYesQuery string used to find all views with matching title
accessstringNoFilter views by access. May be “personal”, “shared”, or “account”
activebooleanNoFilter by active views if true or inactive views if false
group_idintegerNoFilter views by group
sort_bystringNoPossible values are “alphabetical”, “created_at”, “updated_at”, and “position”. If unspecified, the views are sorted by relevance
sort_orderstringNoOne of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others
includestringNoA sideload to include in the response. See Sideloads

zendesk_admin_show_changes_to_ticket

Show Changes to Ticket Parameters:
ParameterTypeRequiredDefaultDescription
macro_idintegerYesThe ID of the macro
normalize_commentbooleanNoIf true, normalizes the newline formatting of the macro’s comment to more closely match the formatting produced by the ticket comment editor

zendesk_admin_update_automation

Update Automation Parameters:
ParameterTypeRequiredDefaultDescription
automation_idintegerYesThe ID of the automation

zendesk_admin_update_macro

Update Macro Parameters:
ParameterTypeRequiredDefaultDescription
macro_idintegerYesThe ID of the macro
macroobjectNoThe macro value

zendesk_admin_update_trigger

Update Ticket Trigger Parameters:
ParameterTypeRequiredDefaultDescription
trigger_idintegerYesThe ID of the trigger
triggerobjectNoThe trigger value

zendesk_admin_update_view

Update View Parameters:
ParameterTypeRequiredDefaultDescription
view_idintegerYesThe ID of the view