/zendesk-admin | Type: Application | PCID required: Yes
Tools
zendesk_admin_create_automation
Create Automationzendesk_admin_create_macro
Create Macro Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
macro | object | No | — | The macro value |
zendesk_admin_create_trigger
Create Trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trigger | object | No | — | The trigger value |
zendesk_admin_create_view
Create Viewzendesk_admin_delete_automation
Delete Automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_id | integer | Yes | — | The ID of the automation |
zendesk_admin_delete_macro
Delete Macro Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
macro_id | integer | Yes | — | The ID of the macro |
zendesk_admin_delete_trigger
Delete Ticket Trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trigger_id | integer | Yes | — | The ID of the trigger |
zendesk_admin_delete_view
Delete View Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
view_id | integer | Yes | — | The ID of the view |
zendesk_admin_execute_view
Execute View Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
view_id | integer | Yes | — | The ID of the view |
page | object | No | — | Pagination 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_by | string | No | — | The ticket field used for sorting. This will either be a title or a custom field id. |
sort_order | string | No | — | The direction the tickets are sorted. May be one of ‘asc’ or ‘desc’ |
include | string | No | — | A comma-separated list of sideloads to include in the response. |
exclude | string | No | — | A comma-separated list of sideloads to exclude from the response. |
group_by | string | No | — | The ticket field used for grouping. This will either be a title or a custom field id. |
zendesk_admin_get_automation
Show Automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_id | integer | Yes | — | The ID of the automation |
zendesk_admin_get_custom_status
Show Custom Ticket Status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
custom_status_id | integer | Yes | — | The id of the custom status |
zendesk_admin_get_macro
Show Macro Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
macro_id | integer | Yes | — | The ID of the macro |
zendesk_admin_get_ticket_field
Show Ticket Field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ticket_field_id | integer | Yes | — | The ID of the ticket field |
creator | boolean | No | — | If 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ticket_form_id | integer | Yes | — | The ID of the ticket form |
zendesk_admin_get_trigger
Show Ticket Trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trigger_id | integer | Yes | — | The ID of the trigger |
zendesk_admin_get_view
Show View Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
view_id | integer | Yes | — | The ID of the view |
include | string | No | — | A comma-separated list of sideloads to include in the response. |
zendesk_admin_list_automations
List Automations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | object | No | — | Pagination 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_page | integer | No | — | Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
sort | string | No | — | Field 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 |
active | boolean | No | — | Filter by active automations if true or inactive automations if false |
include | string | No | — | A sideload to include in the response. See Sideloads |
zendesk_admin_list_custom_statuses
List Custom Ticket Statuses Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status_categories | string | No | — | Filter the list of custom ticket statuses by a comma-separated list of status categories |
active | boolean | No | — | If 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 |
default | boolean | No | — | If 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A sideload to include in the response. See Sideloads |
access | string | No | — | Filter 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. |
active | boolean | No | — | Filter by active macros if true or inactive macros if false |
category | integer | No | — | Filter macros by category |
group_id | integer | No | — | Filter macros by group |
only_viewable | boolean | No | — | If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false |
sort_by | string | No | — | Possible values are “alphabetical”, “created_at”, “updated_at”, “usage_1h”, “usage_24h”, “usage_7d”, or “usage_30d”. Defaults to alphabetical |
sort_order | string | No | — | One of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others |
page | object | No | — | Pagination 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_page | integer | No | — | Number 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
locale | string | No | — | Forces the title_in_portal property to return a dynamic content variant for the specified locale. Only accepts active locale ids. Example: locale="de". |
creator | boolean | No | — | 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, creator_app_name is null |
page | object | No | — | Cursor-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 |
sort | string | No | — | Field 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_indicators | boolean | No | — | When true, includes has_more indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]). |
include_item_cursors | boolean | No | — | When 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | true returns active ticket forms; false returns inactive ticket forms. If not present, returns both |
end_user_visible | boolean | No | — | true returns ticket forms where end_user_visible; false returns ticket forms that are not end-user visible. If not present, returns both |
fallback_to_default | boolean | No | — | true 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_type | string | No | — | Filter 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_brand | boolean | No | — | true returns the ticket forms of the brand specified by the url’s subdomain |
page | object | No | — | Pagination 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_page | integer | No | — | Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
sort | string | No | — | Field 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_indicators | boolean | No | — | When true, includes has_more indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]). |
include_item_cursors | boolean | No | — | When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]). |
locale | string | No | — | Locale 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
view_id | integer | Yes | — | The ID of the view |
sort_by | string | No | — | Sort or group the tickets by a column in the View columns table. The subject and submitter columns are not supported |
sort_order | string | No | — | One of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others |
zendesk_admin_list_triggers
List Ticket Triggers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | Filter by active triggers if true or inactive triggers if false |
sort | string | No | — | Cursor-based pagination only. Possible values are “alphabetical”, “created_at”, “updated_at”, or “position”. |
sort_by | string | No | — | Offset pagination only. Possible values are “alphabetical”, “created_at”, “updated_at”, “usage_1h”, “usage_24h”, or “usage_7d”. Defaults to “position” |
sort_order | string | No | — | One of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others |
category_id | string | No | — | Filter triggers by category ID |
page | object | No | — | Pagination 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_page | integer | No | — | Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
include | string | No | — | A sideload to include in the response. See Sideloads |
zendesk_admin_list_views
List Views Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
access | string | No | — | Only views with given access. May be “personal”, “shared”, or “account” |
active | boolean | No | — | Only active views if true, inactive views if false |
group_id | integer | No | — | Only views belonging to given group |
sort | string | No | — | The sort parameter used with cursor pagination. Defaults to “created_at”. Prefix with ’-’ for descending order |
sort_by | string | No | — | The sort_by parameter used with offset pagination. Possible values are “alphabetical”, “created_at”, or “updated_at”. Defaults to “position” |
sort_order | string | No | — | The sort_order parameter used with offset pagination. One of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others |
page | object | No | — | Pagination 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_page | integer | No | — | Number 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | Yes | — | Query string used to find all automations with matching title |
active | boolean | No | — | Filter by active automations if true or inactive automations if false |
sort_by | string | No | — | Possible values are “alphabetical”, “created_at”, “updated_at”, and “position”. If unspecified, the automations are sorted by relevance |
sort_order | string | No | — | One of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others |
include | string | No | — | A sideload to include in the response. See Sideloads |
zendesk_admin_search_macro
Search Macros Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A sideload to include in the response. See Sideloads |
access | string | No | — | Filter 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. |
active | boolean | No | — | Filter by active macros if true or inactive macros if false |
category | integer | No | — | Filter macros by category |
group_id | integer | No | — | Filter macros by group |
only_viewable | boolean | No | — | If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false |
sort_by | string | No | — | Possible values are “alphabetical”, “created_at”, “updated_at”, or “position”. Defaults to alphabetical |
sort_order | string | No | — | One of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others |
query | string | Yes | — | Query string used to find macros with matching titles |
zendesk_admin_search_macros
Search Macros Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | A sideload to include in the response. See Sideloads |
access | string | No | — | Filter 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. |
active | boolean | No | — | Filter by active macros if true or inactive macros if false |
category | integer | No | — | Filter macros by category |
group_id | integer | No | — | Filter macros by group |
only_viewable | boolean | No | — | If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false |
sort_by | string | No | — | Possible values are “alphabetical”, “created_at”, “updated_at”, or “position”. Defaults to alphabetical |
sort_order | string | No | — | One of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others |
query | string | Yes | — | Query string used to find macros with matching titles |
zendesk_admin_search_triggers
Search Ticket Triggers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | Query string used to find all triggers with matching title |
filter | string | No | — | JSON-encoded trigger attribute filters for the search. See Filter. Example: {"json":{"description":"Close a ticket"}} |
active | boolean | No | — | Filter by active triggers if true or inactive triggers if false |
sort | string | No | — | Cursor-based pagination only. Possible values are “alphabetical”, “created_at”, “updated_at”, or “position”. |
sort_by | string | No | — | Offset pagination only. Possible values are “alphabetical”, “created_at”, “updated_at”, “usage_1h”, “usage_24h”, or “usage_7d”. Defaults to “position” |
sort_order | string | No | — | One of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others |
include | string | No | — | A sideload to include in the response. See Sideloads |
zendesk_admin_search_views
Search Views Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | Yes | — | Query string used to find all views with matching title |
access | string | No | — | Filter views by access. May be “personal”, “shared”, or “account” |
active | boolean | No | — | Filter by active views if true or inactive views if false |
group_id | integer | No | — | Filter views by group |
sort_by | string | No | — | Possible values are “alphabetical”, “created_at”, “updated_at”, and “position”. If unspecified, the views are sorted by relevance |
sort_order | string | No | — | One of “asc” or “desc”. Defaults to “asc” for alphabetical and position sort, “desc” for all others |
include | string | No | — | A sideload to include in the response. See Sideloads |
zendesk_admin_show_changes_to_ticket
Show Changes to Ticket Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
macro_id | integer | Yes | — | The ID of the macro |
normalize_comment | boolean | No | — | If 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_id | integer | Yes | — | The ID of the automation |
zendesk_admin_update_macro
Update Macro Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
macro_id | integer | Yes | — | The ID of the macro |
macro | object | No | — | The macro value |
zendesk_admin_update_trigger
Update Ticket Trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
trigger_id | integer | Yes | — | The ID of the trigger |
trigger | object | No | — | The trigger value |
zendesk_admin_update_view
Update View Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
view_id | integer | Yes | — | The ID of the view |

