# Zendesk on boxd

> Zendesk provides customer support software with ticketing, live chat, and knowledge base features, enabling efficient helpdesk operations and customer engagement.

- Page: https://boxd.sh/integrations/zendesk/
- CLI: `run zendesk` (452 commands, 10 marked common)
- SDK: `import { zendesk } from "@boxd/run"`; every parameter and response type is at `@boxd/run/zendesk`
- Triggers: 2
- Connect: `run auth zendesk` (Sign in with Zendesk), or https://app.boxd.sh/integrations/detail/zendesk
- All integrations: https://boxd.sh/integrations/ (Markdown: https://boxd.sh/integrations/index.md)

## From the shell

```sh
run auth zendesk      # once: prints a link to connect your account
run zendesk           # list its commands
run zendesk list-users
```

Parameters are flags (`--flag value`); object and array parameters take a JSON string. Output is YAML, or JSON with `--json`. Calls use your own connection; `--scope <name>` uses a connection shared with your team.

## From a script

```ts
import { zendesk } from "@boxd/run";

const result = await zendesk.listUsers({});
console.log(result);

zendesk.on("new-ticket", async (event) => {
  // New Zendesk Ticket: runs on this machine, once per event
  console.log(event);
});
```

Run it with `run zendesk.run.ts`. A script that calls `.on()` keeps running as a job and handles each event.

## Commands

Required flags are listed; `run zendesk <command> --help` lists the optional ones. "common" marks what `run zendesk` shows without `--all`.

| Command | SDK method | Required flags | Optional | Description |
|---|---|---|---|---|
| `apply-macro` | `zendesk.applyMacro()` | `--macro-id` `--ticket-id` | 0 | Preview how a Zendesk macro would affect a ticket without actually applying it |
| `autocomplete-problems` | `zendesk.autocompleteProblems()` | `--text` | 0 | Autocomplete problems in Zendesk |
| `autocomplete-users` | `zendesk.autocompleteUsers()` | — | 5 | Search for Zendesk users by name prefix using the POST /api/v2/users/autocomplete endpoint |
| `check-host-mapping-validity-for-existing-brand` | `zendesk.checkHostMappingValidityForExistingBrand()` | `--brand-id` | 0 | Check the host mapping validity for an existing brand in Zendesk |
| `count-custom-object-records` | `zendesk.countCustomObjectRecords()` | `--custom-object-key` | 0 | Count the number of records in a specific Zendesk custom object |
| `count-deleted-users` | `zendesk.countDeletedUsers()` | — | 0 | Count deleted users in Zendesk |
| `count-organizations` | `zendesk.countOrganizations()` | — | 0 | Count the number of organizations in Zendesk |
| `count-user-ccd-tickets` | `zendesk.countUserCcdTickets()` | `--user-id` | 0 | Count tickets where the specified user is CCD (carbon copy distribution) |
| `create-access-rule` | `zendesk.createAccessRule()` | `--access-rule` `--custom-object-key` | 0 | Create an access rule for a custom object in Zendesk |
| `create-apps-installation` | `zendesk.createAppsInstallation()` | `--app-id` | 6 | Install a Zendesk app in the account |
| `create-apps-notify` | `zendesk.createAppsNotify()` | `--app-id` `--event` | 2 | Send a notification to currently open instances of a Zendesk app |
| `create-attachments` | `zendesk.createAttachments()` | `--file` | 0 | Upload a file attachment to Zendesk |
| `create-autocomplete-tags` | `zendesk.createAutocompleteTags()` | — | 1 | Search for Zendesk tags using autocomplete via POST request body |
| `create-automation` | `zendesk.createAutomation()` | `--conditions` `--title` | 3 | Create a new automation in Zendesk |
| `create-bookmark` | `zendesk.createBookmark()` | `--ticket-id` | 0 | Create a bookmark for a ticket in Zendesk |
| `create-comment-redaction` | `zendesk.createCommentRedaction()` | `--text` `--ticket-comment-id` `--ticket-id` | 0 | Redact sensitive content from a ticket comment in Zendesk using the Agent Workspace method |
| `create-custom-object` | `zendesk.createCustomObject()` | `--custom-object` | 0 | Create a new custom object in Zendesk |
| `create-custom-object-bulk-job` | `zendesk.createCustomObjectBulkJob()` | `--action` `--custom-object-key` `--items` | 0 | Create a bulk job to perform batch operations (create, update, delete, upsert) on custom object records in Zendesk |
| `create-custom-object-field` | `zendesk.createCustomObjectField()` | `--custom-object-key` `--key` `--title` `--type` | 9 | Create a new field for a custom object in Zendesk |
| `create-custom-object-record` | `zendesk.createCustomObjectRecord()` | `--custom-object-key` `--name` | 2 | Create a new record for a custom object in Zendesk |
| `create-custom-object-record-attachment` | `zendesk.createCustomObjectRecordAttachment()` | `--custom-object-key` `--file` `--record-id` | 0 | Create an attachment for a custom object record in Zendesk |
| `create-custom-statuses` | `zendesk.createCustomStatuses()` | `--agent-label` `--description` `--end-user-label` `--status-category` | 2 | Create a new custom ticket status in Zendesk |
| `create-deletion-schedule` | `zendesk.createDeletionSchedule()` | `--object` `--title` | 3 | Create a new deletion schedule in Zendesk that automatically deletes records matching specified conditions on a schedule |
| `create-dynamic-content-items` | `zendesk.createDynamicContentItems()` | `--default-locale-id` `--name` `--variants` | 0 | Create a new dynamic content item with locale variants in Zendesk |
| `create-dynamic-content-items-variants` | `zendesk.createDynamicContentItemsVariants()` | `--content` `--dynamic-content-item-id` `--locale-id` | 2 | Create a new locale variant for an existing dynamic content item in Zendesk |
| `create-end-user-identity` | `zendesk.createEndUserIdentity()` | `--type` `--user-id` `--value` | 1 | Add an identity (email or phone) to an end user's profile in Zendesk |
| `create-group` | `zendesk.createGroup()` | `--name` | 2 | Create a new group in Zendesk |
| `create-group-memberships` | `zendesk.createGroupMemberships()` | `--group-id` `--user-id` | 1 | Create a group membership in Zendesk, assigning an agent to a group |
| `create-import-ticket` | `zendesk.createImportTicket()` | `--description` `--subject` | 19 | Import a ticket into Zendesk with historical timestamps |
| `create-imports-tickets-create-many` | `zendesk.createImportsTicketsCreateMany()` | `--tickets` | 1 | Bulk import tickets into Zendesk by posting up to 100 ticket objects at a time |
| `create-many-dynamic-content-items-variants` | `zendesk.createManyDynamicContentItemsVariants()` | `--dynamic-content-item-id` `--variants` | 0 | Create many locale variants for an existing dynamic content item in Zendesk |
| `create-many-tickets` | `zendesk.createManyTickets()` | `--tickets` | 0 | Create many tickets in Zendesk in a single request |
| `create-many-users` | `zendesk.createManyUsers()` | `--users` | 1 | Create many users in Zendesk in a single request |
| `create-object-trigger` | `zendesk.createObjectTrigger()` | `--actions` `--conditions` `--custom-object-key` `--title` | 3 | Create a new trigger for a custom object in Zendesk |
| `create-or-update-many-users` | `zendesk.createOrUpdateManyUsers()` | `--users` | 0 | Create or update multiple users in Zendesk in a single request |
| `create-or-update-organization` | `zendesk.createOrUpdateOrganization()` | `--name` | 9 | Create or update a Zendesk organization in a single operation |
| `create-or-update-user` | `zendesk.createOrUpdateUser()` | `--user` | 0 | Create or update a Zendesk user |
| `create-organization` | `zendesk.createOrganization()` | `--name` | 8 | Create a new organization in Zendesk |
| `create-organization-field` | `zendesk.createOrganizationField()` | `--key` `--title` `--type` | 8 | Create a custom organization field in Zendesk |
| `create-organization-memberships` | `zendesk.createOrganizationMemberships()` | `--organization-id` `--user-id` | 1 | Create a new organization membership in Zendesk by assigning a user to an organization |
| `create-organization-memberships-create-many` | `zendesk.createOrganizationMembershipsCreateMany()` | `--organization-memberships` | 0 | Create multiple organization memberships in Zendesk by posting up to 100 membership objects at a time |
| `create-organization-merge` | `zendesk.createOrganizationMerge()` | `--organization-id` `--winner-id` | 0 | Merge two Zendesk organizations by combining all users, tickets, and data from the losing organization into the winning organization |
| `create-organization-subscription` | `zendesk.createOrganizationSubscription()` | `--organization-id` `--user-id` | 0 | Create an organization subscription in Zendesk |
| `create-organizations-tags` | `zendesk.createOrganizationsTags()` | `--organization-id` `--tags` | 0 | Set organization tags in Zendesk by making a POST request to replace the tags on an organization |
| `create-push-notification-devices-destroy-many` | `zendesk.createPushNotificationDevicesDestroyMany()` | `--push-notification-devices` | 0 | Bulk unregister push notification devices in Zendesk |
| `create-request` | `zendesk.createRequest()` | `--comment-body` `--subject` | 10 | Create a new request in Zendesk |
| `create-resource-collections` | `zendesk.createResourceCollections()` | `--actions` `--title` | 0 | Create a resource collection in Zendesk |
| `create-side-conversation` | `zendesk.createSideConversation()` | `--body` `--ticket-id` `--to` | 4 | Create a private side conversation on a Zendesk ticket |
| `create-support-address` | `zendesk.createSupportAddress()` | `--email` `--name` | 2 | Create a new support address (recipient address) in Zendesk |
| `create-suspended-tickets-export` | `zendesk.createSuspendedTicketsExport()` | — | 0 | Export Suspended Tickets from Zendesk Support |
| `create-target` | `zendesk.createTarget()` | `--target-type` `--title` | 20 | Create a target in Zendesk for triggering outbound integrations |
| `create-ticket` | `zendesk.createTicket()` | `--description` `--subject` | 19 | Create a ticket in Zendesk with full support for all ticket fields |
| `create-ticket-content-pin` | `zendesk.createTicketContentPin()` | `--content-id` `--content-type` `--ticket-id` | 1 | Create a ticket content pin in Zendesk |
| `create-ticket-field` | `zendesk.createTicketField()` | `--title` `--type` | 16 | Create a custom ticket field in Zendesk with various field types |
| `create-ticket-field-option` | `zendesk.createTicketFieldOption()` | `--name` `--ticket-field-id` `--value` | 2 | Create or update an option for a dropdown or multiselect ticket field |
| `create-ticket-or-voicemail-ticket` | `zendesk.createTicketOrVoicemailTicket()` | `--description` `--subject` | 14 | Create a ticket in Zendesk via the voice/channel API endpoint |
| `create-trigger` | `zendesk.createTrigger()` | `--actions` `--conditions` `--title` | 3 | Create a new trigger in Zendesk |
| `create-trigger-categories-job` | `zendesk.createTriggerCategoriesJob()` | `--trigger-category-ids` | 1 | Create a batch job for ticket trigger categories in Zendesk |
| `create-trigger-category` | `zendesk.createTriggerCategory()` | `--name` | 1 | Create a new trigger category in Zendesk |
| `create-user` | `zendesk.createUser()` | `--user` | 1 | Create a new user in Zendesk |
| `create-user-field` | `zendesk.createUserField()` | `--key` `--title` `--type` | 10 | Create a custom user field in Zendesk |
| `create-user-field-option` | `zendesk.createUserFieldOption()` | `--name` `--user-field-id` `--value` | 2 | Create or update an option for a dropdown or multiselect user field |
| `create-user-identity` | `zendesk.createUserIdentity()` | `--type` `--user-id` `--value` | 1 | Add an identity to a user's profile in Zendesk |
| `create-user-profiles-events` | `zendesk.createUserProfilesEvents()` | `--event` `--profile` | 0 | Store an event against a Sunshine user profile |
| `create-users-logout-many` | `zendesk.createUsersLogoutMany()` | `--ids` | 0 | Log out multiple users in Zendesk by ending their active sessions |
| `create-users-organization-memberships` | `zendesk.createUsersOrganizationMemberships()` | `--organization-id` `--user-id` | 1 | Create a new organization membership for a specific user in Zendesk by assigning a user to an organization |
| `create-users-tags` | `zendesk.createUsersTags()` | `--tags` `--user-id` | 0 | Set tags on a Zendesk user via POST request to /api/v2/users/{user_id}/tags |
| `create-view` | `zendesk.createView()` | `--conditions` `--title` | 4 | Create a new view in Zendesk |
| `create-views-preview` | `zendesk.createViewsPreview()` | `--view` | 5 | Preview a Zendesk view by constructing conditions and execution settings to see which tickets match |
| `create-views-preview-count` | `zendesk.createViewsPreviewCount()` | `--all-conditions` | 2 | Preview ticket count for a view in Zendesk |
| `delete-access-rule` | `zendesk.deleteAccessRule()` | `--custom-object-key` `--id` | 0 | Delete an access rule for a custom object in Zendesk |
| `delete-app-installation` | `zendesk.deleteAppInstallation()` | `--app-installation-id` | 0 | Permanently removes an installed app from Zendesk |
| `delete-automation` | `zendesk.deleteAutomation()` | `--automation-id` | 0 | Permanently deletes an automation in Zendesk |
| `delete-bookmark` | `zendesk.deleteBookmark()` | `--bookmark-id` | 0 | Permanently deletes a bookmark in Zendesk |
| `delete-business-hours-schedule` | `zendesk.deleteBusinessHoursSchedule()` | `--schedule-id` | 0 | Permanently deletes a business hours schedule in Zendesk |
| `delete-custom-object` | `zendesk.deleteCustomObject()` | `--custom-object-key` | 0 | Permanently deletes a custom object definition in Zendesk |
| `delete-custom-object-field` | `zendesk.deleteCustomObjectField()` | `--custom-object-field-key-or-id` `--custom-object-key` | 0 | Permanently deletes a custom object field in Zendesk |
| `delete-custom-object-record` | `zendesk.deleteCustomObjectRecord()` | `--custom-object-key` `--custom-object-record-id` | 0 | Permanently deletes a custom object record in Zendesk |
| `delete-custom-object-record-attachment` | `zendesk.deleteCustomObjectRecordAttachment()` | `--custom-object-key` `--id` `--record-id` | 0 | Permanently deletes an attachment from a custom object record in Zendesk |
| `delete-custom-object-record-by-external-id-or-name` | `zendesk.deleteCustomObjectRecordByExternalIdOrName()` | `--custom-object-key` | 2 | Permanently deletes a custom object record in Zendesk by its external ID or name |
| `delete-custom-status` | `zendesk.deleteCustomStatus()` | `--custom-status-id` | 0 | Permanently deletes a custom ticket status in Zendesk |
| `delete-deleted-ticket` | `zendesk.deleteDeletedTicket()` | `--ticket-id` | 0 | Permanently deletes a soft-deleted ticket from Zendesk |
| `delete-deletion-schedule` | `zendesk.deleteDeletionSchedule()` | `--deletion-schedule-id` | 0 | Permanently deletes a deletion schedule in Zendesk |
| `delete-dynamic-content-item` | `zendesk.deleteDynamicContentItem()` | `--dynamic-content-item-id` | 0 | Permanently deletes a dynamic content item in Zendesk |
| `delete-dynamic-content-item-variant` | `zendesk.deleteDynamicContentItemVariant()` | `--dynamic-content-item-id` `--dynamic-content-variant-id` | 0 | Permanently deletes a dynamic content item variant in Zendesk |
| `delete-group-membership` | `zendesk.deleteGroupMembership()` | `--group-membership-id` | 0 | Permanently deletes a group membership in Zendesk, immediately removing a user from a group |
| `delete-group-memberships-destroy-many` | `zendesk.deleteGroupMembershipsDestroyMany()` | — | 1 | Bulk delete group memberships in Zendesk |
| `delete-macro` | `zendesk.deleteMacro()` | `--macro-id` | 0 | Permanently deletes a macro in Zendesk |
| `delete-macros-destroy-many` | `zendesk.deleteMacrosDestroyMany()` | `--ids` | 0 | Bulk delete macros in Zendesk |
| `delete-many-automations` | `zendesk.deleteManyAutomations()` | `--ids` | 0 | Bulk delete automations in Zendesk |
| `delete-many-object-triggers` | `zendesk.deleteManyObjectTriggers()` | `--custom-object-key` `--ids` | 0 | Bulk delete triggers for a Zendesk custom object |
| `delete-many-organization-memberships` | `zendesk.deleteManyOrganizationMemberships()` | `--ids` | 0 | Bulk delete organization memberships in Zendesk |
| `delete-many-views` | `zendesk.deleteManyViews()` | `--ids` | 0 | Bulk delete views in Zendesk |
| `delete-object-trigger` | `zendesk.deleteObjectTrigger()` | `--custom-object-key` `--trigger-id` | 0 | Permanently deletes a custom object trigger in Zendesk |
| `delete-organization` | `zendesk.deleteOrganization()` | `--organization-id` | 0 | Delete an organization in Zendesk |
| `delete-organization-field` | `zendesk.deleteOrganizationField()` | `--organization-field-id` | 0 | Permanently deletes an organization field in Zendesk |
| `delete-organization-membership` | `zendesk.deleteOrganizationMembership()` | `--organization-membership-id` | 0 | Permanently removes a user from an organization in Zendesk by deleting the organization membership |
| `delete-organization-subscription` | `zendesk.deleteOrganizationSubscription()` | `--organization-subscription-id` | 0 | Permanently deletes an organization subscription in Zendesk |
| `delete-organizations-tags` | `zendesk.deleteOrganizationsTags()` | `--organization-id` | 0 | Remove all tags from a Zendesk organization |
| `delete-resource-collections` | `zendesk.deleteResourceCollections()` | `--resource-collection-id` | 0 | Delete a resource collection in Zendesk |
| `delete-support-address` | `zendesk.deleteSupportAddress()` | `--support-address-id` | 0 | Permanently deletes a support address from Zendesk |
| `delete-suspended-tickets-destroy-many` | `zendesk.deleteSuspendedTicketsDestroyMany()` | `--ids` | 0 | Permanently deletes multiple suspended tickets in Zendesk |
| `delete-target` | `zendesk.deleteTarget()` | `--target-id` | 0 | Permanently deletes a target in Zendesk |
| `delete-ticket` | `zendesk.deleteTicket()` | `--ticket-id` | 0 | Permanently deletes a ticket in Zendesk, including its entire conversation history |
| `delete-ticket-field` | `zendesk.deleteTicketField()` | `--ticket-field-id` | 1 | Permanently deletes a ticket field in Zendesk |
| `delete-ticket-field-option` | `zendesk.deleteTicketFieldOption()` | `--ticket-field-id` `--ticket-field-option-id` | 0 | Permanently deletes an option from a ticket field in Zendesk |
| `delete-tickets-tags` | `zendesk.deleteTicketsTags()` | `--ticket-id` | 1 | Remove tags from a Zendesk ticket |
| `delete-trigger` | `zendesk.deleteTrigger()` | `--trigger-id` | 0 | Permanently deletes a trigger in Zendesk |
| `delete-trigger-category` | `zendesk.deleteTriggerCategory()` | `--trigger-category-id` | 0 | Permanently deletes a trigger category in Zendesk |
| `delete-user` | `zendesk.deleteUser()` | `--user-id` | 0 | Permanently delete a user from Zendesk |
| `delete-user-field` | `zendesk.deleteUserField()` | `--user-field-id` | 0 | Permanently deletes a user field in Zendesk, removing it from all user profiles |
| `delete-user-field-option` | `zendesk.deleteUserFieldOption()` | `--user-field-id` `--user-field-option-id` | 0 | Permanently deletes an option from a user field in Zendesk |
| `delete-user-permanently` | `zendesk.deleteUserPermanently()` | `--deleted-user-id` | 0 | Permanently deletes a soft-deleted user from Zendesk |
| `delete-user-profile` | `zendesk.deleteUserProfile()` | `--profile-id` | 0 | Permanently deletes a user profile in Zendesk by its profile ID |
| `delete-user-session` | `zendesk.deleteUserSession()` | `--session-id` `--user-id` | 0 | Delete a specific user session in Zendesk |
| `delete-users-destroy-many` | `zendesk.deleteUsersDestroyMany()` | — | 2 | Bulk delete users from Zendesk by their IDs or external IDs |
| `delete-users-group-memberships` | `zendesk.deleteUsersGroupMemberships()` | `--group-membership-id` `--user-id` | 0 | Permanently deletes a user's group membership in Zendesk, immediately removing a user from a group |
| `delete-users-identity` | `zendesk.deleteUsersIdentity()` | `--user-id` `--user-identity-id` | 0 | Deletes an identity for a given user in Zendesk |
| `delete-users-me-logout` | `zendesk.deleteUsersMeLogout()` | — | 0 | Delete the current authenticated session in Zendesk |
| `delete-users-organization-memberships` | `zendesk.deleteUsersOrganizationMemberships()` | `--organization-membership-id` `--user-id` | 0 | Permanently removes a user from an organization in Zendesk by deleting the organization membership for a specific user |
| `delete-users-sessions` | `zendesk.deleteUsersSessions()` | `--user-id` | 0 | Bulk delete all sessions for a specific user in Zendesk |
| `delete-users-tags` | `zendesk.deleteUsersTags()` | `--user-id` | 1 | Remove tags from a Zendesk user |
| `delete-view` | `zendesk.deleteView()` | `--view-id` | 0 | Delete a single view in Zendesk |
| `destroy-many-deleted-tickets` | `zendesk.destroyManyDeletedTickets()` | `--ids` | 0 | Permanently deletes multiple soft-deleted tickets in Zendesk |
| `destroy-many-organizations` | `zendesk.destroyManyOrganizations()` | — | 2 | Bulk delete Zendesk organizations |
| `detect-best-locale` | `zendesk.detectBestLocale()` | — | 0 | Detect the best language/locale for the current user based on their browser settings and account preferences |
| `download-custom-object-record-attachment` | `zendesk.downloadCustomObjectRecordAttachment()` | `--custom-object-key` `--id` `--record-id` | 1 | Download attachment file from a Zendesk custom object record |
| `get-about-me` | `zendesk.getAboutMe()` | — | 0 | Get information about the currently authenticated user in Zendesk |
| `get-account-settings` | `zendesk.getAccountSettings()` | — | 1 | Retrieve Zendesk account settings |
| `get-active-triggers` | `zendesk.getActiveTriggers()` | — | 6 | List all active ticket triggers in Zendesk |
| `get-activities` | `zendesk.getActivities()` | — | 5 | List ticket activities in the last 30 days affecting your Zendesk |
| `get-activities-count` | `zendesk.getActivitiesCount()` | — | 0 | Count ticket activities in Zendesk |
| `get-all-organizations` | `zendesk.getAllOrganizations()` | — | 0 | Get all organizations in Zendesk |
| `get-app` | `zendesk.getApp()` | `--app-id` | 0 | Get a single Zendesk app by its numeric ID |
| `get-apps-installations-requirements` | `zendesk.getAppsInstallationsRequirements()` | `--app-installation-id` | 0 | List all requirements for a Zendesk app installation |
| `get-apps-location` | `zendesk.getAppsLocation()` | `--app-location-id` | 0 | Get details for a specific Zendesk app location by its numeric ID |
| `get-apps-location-installations` | `zendesk.getAppsLocationInstallations()` | — | 0 | List all apps location installations from Zendesk |
| `get-apps-public-key` | `zendesk.getAppsPublicKey()` | `--app-id` | 0 | Retrieves the public key for a specific Zendesk app |
| `get-apps-public-key-pem` | `zendesk.getAppsPublicKeyPem()` | `--app-id` | 0 | Retrieves the public key for a specific Zendesk app in PEM format |
| `get-attachment` ·common | `zendesk.getAttachment()` | `--attachment-id` | 0 | Retrieve details of a single Zendesk attachment by its ID |
| `get-autocomplete-tags` | `zendesk.getAutocompleteTags()` | — | 1 | Search for Zendesk tags using autocomplete |
| `get-automation` | `zendesk.getAutomation()` | `--automation-id` | 0 | Show a specific automation by its ID |
| `get-automations` | `zendesk.getAutomations()` | — | 5 | List all automations for the current Zendesk account |
| `get-automations-search` | `zendesk.getAutomationsSearch()` | `--query` | 4 | Search for Zendesk automations by their title |
| `get-brands` | `zendesk.getBrands()` | — | 4 | List all brands configured in your Zendesk account |
| `get-brands-agents` | `zendesk.getBrandsAgents()` | `--brand-id` | 3 | List agents assigned to a specific brand in Zendesk |
| `get-brands2` | `zendesk.getBrands2()` | `--brand-id` | 0 | Show a Brand |
| `get-custom-object-fields-limit` | `zendesk.getCustomObjectFieldsLimit()` | `--custom-object-key` | 0 | Get the current count and maximum limit for custom object fields in Zendesk |
| `get-custom-object-records-limit` | `zendesk.getCustomObjectRecordsLimit()` | — | 0 | Get the current record limit and usage count for custom objects in Zendesk |
| `get-custom-objects-limit` | `zendesk.getCustomObjectsLimit()` | — | 0 | Get the current count and maximum limit for custom objects in Zendesk |
| `get-custom-roles` | `zendesk.getCustomRoles()` | — | 0 | List all custom roles configured in your Zendesk account |
| `get-custom-status` | `zendesk.getCustomStatus()` | `--custom-status-id` | 0 | Get a specific custom ticket status from Zendesk by its ID |
| `get-custom-statuses` | `zendesk.getCustomStatuses()` | — | 3 | List custom ticket statuses available in a Zendesk account |
| `get-deleted-tickets` | `zendesk.getDeletedTickets()` | — | 5 | Lists tickets that have been deleted from Zendesk, showing up to 100 deleted tickets per page with pagination |
| `get-deleted-user` | `zendesk.getDeletedUser()` | `--deleted-user-id` | 0 | Retrieves a single deleted Zendesk user by their ID |
| `get-deletion-schedule` | `zendesk.getDeletionSchedule()` | `--deletion-schedule-id` | 0 | Retrieve a specific deletion schedule from Zendesk by its ID |
| `get-deletion-schedules` | `zendesk.getDeletionSchedules()` | — | 0 | List all deletion schedules for the current Zendesk account |
| `get-dynamic-content-item-show` | `zendesk.getDynamicContentItemShow()` | `--dynamic-content-item-id` | 0 | Show a specific dynamic content item by its ID |
| `get-dynamic-content-item-variant` | `zendesk.getDynamicContentItemVariant()` | `--dynamic-content-item-id` `--dynamic-content-variant-id` | 0 | Show a specific variant of a dynamic content item in Zendesk |
| `get-dynamic-content-items` | `zendesk.getDynamicContentItems()` | — | 3 | List all dynamic content items configured in your Zendesk account |
| `get-dynamic-content-items-show-many` | `zendesk.getDynamicContentItemsShowMany()` | — | 3 | Retrieve multiple dynamic content items by their identifiers |
| `get-dynamic-content-items-variants` | `zendesk.getDynamicContentItemsVariants()` | `--dynamic-content-item-id` | 3 | List all variants of a specific Zendesk dynamic content item |
| `get-email-notification` | `zendesk.getEmailNotification()` | `--notification-id` | 0 | Retrieve details of a single email notification in Zendesk by its notification ID |
| `get-email-notifications` | `zendesk.getEmailNotifications()` | — | 5 | List email notifications from Zendesk |
| `get-email-notifications-show-many` | `zendesk.getEmailNotificationsShowMany()` | — | 3 | Show details of many email notifications in Zendesk |
| `get-end-user-identities` | `zendesk.getEndUserIdentities()` | `--user-id` | 6 | List all identities associated with a specific end user |
| `get-end-user-identity` | `zendesk.getEndUserIdentity()` | `--user-id` `--user-identity-id` | 0 | Fetch a specific end user identity by user ID and identity ID |
| `get-group-membership` | `zendesk.getGroupMembership()` | `--group-membership-id` | 0 | Get a group membership by its unique ID |
| `get-group-memberships` | `zendesk.getGroupMemberships()` | — | 7 | List all group memberships in your Zendesk account |
| `get-group-memberships-by-group` | `zendesk.getGroupMembershipsByGroup()` | `--group-id` | 7 | List group memberships for a specific Zendesk group |
| `get-group-users` | `zendesk.getGroupUsers()` | `--group-id` | 6 | List all users belonging to a specific Zendesk group |
| `get-groups-assignable` | `zendesk.getGroupsAssignable()` | — | 5 | List all groups that can be assigned to tickets or users in your Zendesk account |
| `get-groups-count` | `zendesk.getGroupsCount()` | — | 0 | Count groups in Zendesk |
| `get-groups-users-count` | `zendesk.getGroupsUsersCount()` | `--group-id` | 3 | Count users in a specific Zendesk group |
| `get-guide-survey-responses` | `zendesk.getGuideSurveyResponses()` | — | 8 | List survey responses from Zendesk Guide |
| `get-guide-surveys` | `zendesk.getGuideSurveys()` | `--locale` | 3 | List available CSAT (Customer Satisfaction) surveys in Zendesk Guide |
| `get-incremental-organizations` | `zendesk.getIncrementalOrganizations()` | `--start-time` | 1 | Retrieve organizations that have been modified since a specified start time using the Incremental Organization Export API |
| `get-incremental-routing-attribute-values` | `zendesk.getIncrementalRoutingAttributeValues()` | `--start-time` | 2 | Retrieve routing attribute values that have been modified since a specified start time using the Incremental Skill-Based Routing API |
| `get-incremental-routing-attributes` | `zendesk.getIncrementalRoutingAttributes()` | — | 3 | Export routing attributes incrementally with optional start_time filtering and cursor-based pagination |
| `get-incremental-routing-instance-values` | `zendesk.getIncrementalRoutingInstanceValues()` | — | 1 | Export incremental routing instance values from Zendesk skill-based routing |
| `get-incremental-sample` | `zendesk.getIncrementalSample()` | `--incremental-resource` `--start-time` | 1 | Test the incremental export by retrieving a sample of records that have changed since a specified start time |
| `get-incremental-ticket-events` | `zendesk.getIncrementalTicketEvents()` | `--start-time` | 2 | Export incremental ticket events from Zendesk |
| `get-incremental-ticket-metric-events` | `zendesk.getIncrementalTicketMetricEvents()` | `--start-time` | 4 | List ticket metric events in Zendesk that occurred on or after a specified time |
| `get-incremental-tickets` | `zendesk.getIncrementalTickets()` | `--start-time` | 2 | Retrieve tickets that have been modified since a specified start time using the Incremental Ticket Export API |
| `get-incremental-tickets-cursor` | `zendesk.getIncrementalTicketsCursor()` | — | 3 | Export tickets incrementally using cursor-based pagination |
| `get-incremental-users` | `zendesk.getIncrementalUsers()` | `--start-time` | 1 | Retrieve users that have been modified since a specified start time using the Incremental User Export API |
| `get-incremental-users-cursor` | `zendesk.getIncrementalUsersCursor()` | — | 3 | Export users incrementally using cursor-based pagination |
| `get-job-statuses` | `zendesk.getJobStatuses()` | — | 3 | List job statuses from Zendesk |
| `get-job-statuses2` | `zendesk.getJobStatuses2()` | `--job-status-id` | 0 | Get a single job status by ID from Zendesk |
| `get-locale` | `zendesk.getLocale()` | `--locale-id` | 0 | Get a locale by its ID or BCP-47 code |
| `get-locales` | `zendesk.getLocales()` | — | 2 | List all translation locales available for your Zendesk account |
| `get-locales-agent` | `zendesk.getLocalesAgent()` | — | 0 | List the translation locales that have been localized for agent use |
| `get-locales-current` | `zendesk.getLocalesCurrent()` | — | 0 | Show the current locale for a Zendesk account |
| `get-macro-attachments` | `zendesk.getMacroAttachments()` | `--macro-id` | 0 | List all attachments associated with a specific Zendesk macro |
| `get-macro-categories` | `zendesk.getMacroCategories()` | — | 0 | List all macro categories available to the current Zendesk account |
| `get-macro-definitions` | `zendesk.getMacroDefinitions()` | — | 0 | Retrieve the definitions of all actions that a macro can perform in Zendesk |
| `get-macro-replica` | `zendesk.getMacroReplica()` | `--macro-id` `--ticket-id` | 0 | Show a macro replica (unpersisted macro representation) based on a macro ID and ticket ID |
| `get-macro2` | `zendesk.getMacro2()` | `--macro-id` | 1 | Show a specific macro by its ID |
| `get-macros` | `zendesk.getMacros()` | — | 10 | List all shared and personal macros available in your Zendesk account |
| `get-macros-actions` | `zendesk.getMacrosActions()` | — | 0 | List supported actions for macros in Zendesk |
| `get-macros-active` | `zendesk.getMacrosActive()` | — | 11 | List all active shared and personal macros in Zendesk |
| `get-macros-apply` | `zendesk.getMacrosApply()` | `--macro-id` | 0 | Show changes to a ticket that would result from applying a macro |
| `get-macros-search` | `zendesk.getMacrosSearch()` | `--query` | 8 | Search for Zendesk macros by their title |
| `get-object-trigger` | `zendesk.getObjectTrigger()` | `--custom-object-key` `--trigger-id` | 0 | Show a specific trigger for a custom object in Zendesk |
| `get-open-requests` | `zendesk.getOpenRequests()` | — | 4 | List open requests from Zendesk |
| `get-organization` | `zendesk.getOrganization()` | `--organization-id` | 0 | Get metadata for a specific Zendesk organization by ID |
| `get-organization-field2` | `zendesk.getOrganizationField2()` | `--organization-field-id` | 1 | Get details for a specific organization field in Zendesk by its ID or key |
| `get-organization-fields` | `zendesk.getOrganizationFields()` | — | 2 | List all custom organization fields for the Zendesk account |
| `get-organization-membership2` | `zendesk.getOrganizationMembership2()` | `--organization-membership-id` | 0 | Get details for a specific organization membership by its ID |
| `get-organization-merge` | `zendesk.getOrganizationMerge()` | `--organization-merge-id` | 0 | Retrieve the details of a specific organization merge operation in Zendesk |
| `get-organization-related` | `zendesk.getOrganizationRelated()` | `--organization-id` | 0 | Get related counts and information for a specific Zendesk organization by ID |
| `get-organization-requests` | `zendesk.getOrganizationRequests()` | `--organization-id` | 7 | List requests for a specific Zendesk organization |
| `get-organization-subscription` | `zendesk.getOrganizationSubscription()` | `--organization-subscription-id` | 0 | Show Organization Subscription - retrieves details of a specific organization subscription by its ID |
| `get-organization-subscriptions` | `zendesk.getOrganizationSubscriptions()` | — | 5 | List Organization Subscriptions in Zendesk |
| `get-organization-tags` | `zendesk.getOrganizationTags()` | `--organization-id` | 0 | List all tags associated with a specific Zendesk organization |
| `get-organization-tickets` | `zendesk.getOrganizationTickets()` | `--organization-id` | 4 | Get tickets for a specific organization in Zendesk |
| `get-organization-users` | `zendesk.getOrganizationUsers()` | `--organization-id` | 8 | List all users associated with a specific Zendesk organization |
| `get-organization-users-count` | `zendesk.getOrganizationUsersCount()` | `--organization-id` | 2 | Count users in a specific Zendesk organization by ID |
| `get-organizations-autocomplete` | `zendesk.getOrganizationsAutocomplete()` | `--name` | 2 | Search for Zendesk organizations using autocomplete |
| `get-organizations-merges` | `zendesk.getOrganizationsMerges()` | `--organization-id` | 2 | List all organization merge operations for a specific organization in Zendesk |
| `get-organizations-show-many` | `zendesk.getOrganizationsShowMany()` | — | 2 | Show many Zendesk organizations by their IDs or external IDs |
| `get-organizations-subscriptions` | `zendesk.getOrganizationsSubscriptions()` | `--organization-id` | 2 | List all organization subscriptions for a specific Zendesk organization |
| `get-organizations-tickets-count` | `zendesk.getOrganizationsTicketsCount()` | `--organization-id` | 0 | Count organization tickets in Zendesk |
| `get-owned-apps` | `zendesk.getOwnedApps()` | — | 3 | List apps owned by the current Zendesk account |
| `get-problems` | `zendesk.getProblems()` | — | 9 | List Zendesk ticket problems |
| `get-public-locales` | `zendesk.getPublicLocales()` | — | 0 | List all available public locales that can be used for translations in Zendesk |
| `get-recent-tickets` | `zendesk.getRecentTickets()` | — | 2 | List recently viewed tickets in Zendesk |
| `get-remote-authentications` | `zendesk.getRemoteAuthentications()` | — | 0 | List all remote authentication configurations in your Zendesk account |
| `get-request-comments` | `zendesk.getRequestComments()` | `--request-id` | 4 | List comments on a Zendesk request |
| `get-requests` | `zendesk.getRequests()` | — | 4 | List ticket requests in Zendesk |
| `get-requests-ccdb` | `zendesk.getRequestsCcdb()` | — | 4 | List CCD Requests |
| `get-requests-comment` | `zendesk.getRequestsComment()` | `--request-id` `--ticket-comment-id` | 0 | Get a specific comment from a Zendesk request |
| `get-requests-search` | `zendesk.getRequestsSearch()` | — | 5 | Search for requests in Zendesk using query syntax |
| `get-requests-solved` | `zendesk.getRequestsSolved()` | — | 4 | List Zendesk requests with the 'solved' status |
| `get-routing-agents-instance-values` | `zendesk.getRoutingAgentsInstanceValues()` | `--agent-ids` | 1 | Retrieve attribute values for multiple agents/users using the Skill-Based Routing API |
| `get-satisfaction-ratings` | `zendesk.getSatisfactionRatings()` | — | 3 | List satisfaction ratings for tickets in Zendesk |
| `get-satisfaction-ratings-count` | `zendesk.getSatisfactionRatingsCount()` | — | 0 | Count satisfaction ratings in Zendesk |
| `get-search-count` | `zendesk.getSearchCount()` | `--query` | 0 | Count the number of items matching a search query in Zendesk |
| `get-search-export` | `zendesk.getSearchExport()` | `--query` | 4 | Export search results from Zendesk using cursor-based pagination |
| `get-security-settings` | `zendesk.getSecuritySettings()` | — | 0 | Show Security Settings for a Zendesk account |
| `get-sessions` | `zendesk.getSessions()` | — | 2 | List all active sessions in your Zendesk account |
| `get-sharing-agreements` | `zendesk.getSharingAgreements()` | — | 0 | List all sharing agreements for your Zendesk account |
| `get-side-conversations-events` | `zendesk.getSideConversationsEvents()` | `--start-time` | 2 | Retrieve side conversation events for incremental export |
| `get-support-address` | `zendesk.getSupportAddress()` | `--support-address-id` | 0 | Get a support address by its unique ID |
| `get-suspended-tickets` | `zendesk.getSuspendedTickets()` | — | 4 | List suspended tickets in Zendesk |
| `get-tags` | `zendesk.getTags()` | — | 3 | List Zendesk tags in order of popularity |
| `get-tags-count` | `zendesk.getTagsCount()` | — | 0 | Count Tags in Zendesk |
| `get-target` | `zendesk.getTarget()` | `--target-id` | 0 | Show a specific target by its ID |
| `get-target-failure` | `zendesk.getTargetFailure()` | `--target-failure-id` | 0 | Show a target failure in Zendesk |
| `get-target-failures` | `zendesk.getTargetFailures()` | — | 0 | List the 25 most recent target failures in Zendesk |
| `get-targets` | `zendesk.getTargets()` | — | 2 | List all targets for the current Zendesk account |
| `get-ticket-audit-by-id` | `zendesk.getTicketAuditById()` | `--ticket-audit-id` `--ticket-id` | 0 | Show a specific audit for a ticket from Zendesk |
| `get-ticket-by-id` | `zendesk.getTicketById()` | `--ticket-id` | 2 | Get ticket details from Zendesk |
| `get-ticket-collaborators` | `zendesk.getTicketCollaborators()` | `--ticket-id` | 2 | List all collaborators (CC'd users) on a Zendesk ticket |
| `get-ticket-comments` | `zendesk.getTicketComments()` | `--ticket-id` | 4 | List comments on a Zendesk ticket |
| `get-ticket-email-c-cs` | `zendesk.getTicketEmailCCs()` | `--ticket-id` | 0 | List Email CCs for a Ticket |
| `get-ticket-field2` | `zendesk.getTicketField2()` | `--ticket-field-id` | 1 | Show a specific ticket field by its ID |
| `get-ticket-fields` | `zendesk.getTicketFields()` | — | 8 | List all system and custom ticket fields in Zendesk |
| `get-ticket-fields-count` | `zendesk.getTicketFieldsCount()` | — | 0 | Count ticket fields in Zendesk |
| `get-ticket-fields-options` | `zendesk.getTicketFieldsOptions()` | `--ticket-field-id` | 0 | List Ticket Field Options - Returns a list of custom ticket field options for dropdown and multi-select ticket fields |
| `get-ticket-fields-options2` | `zendesk.getTicketFieldsOptions2()` | `--ticket-field-id` `--ticket-field-option-id` | 0 | Show Ticket Field Option - Retrieves a specific custom ticket field option for dropdown and multi-select ticket fields |
| `get-ticket-fields-show-many` | `zendesk.getTicketFieldsShowMany()` | — | 4 | Retrieve multiple ticket fields by their IDs or keys in a single request |
| `get-ticket-followers` | `zendesk.getTicketFollowers()` | `--ticket-id` | 2 | List all followers on a Zendesk ticket |
| `get-ticket-form` | `zendesk.getTicketForm()` | `--ticket-form-id` | 0 | Get details for a specific ticket form in Zendesk by its ID |
| `get-ticket-forms` | `zendesk.getTicketForms()` | — | 11 | List all ticket forms configured in your Zendesk account |
| `get-ticket-forms-show-many` | `zendesk.getTicketFormsShowMany()` | `--ids` | 6 | Show multiple ticket forms by their IDs |
| `get-ticket-incidents` | `zendesk.getTicketIncidents()` | `--ticket-id` | 5 | List incidents linked to a problem ticket in Zendesk |
| `get-ticket-metric` | `zendesk.getTicketMetric()` | `--ticket-metric-id` | 0 | Retrieve a specific ticket metric from Zendesk by its ID |
| `get-ticket-metrics` | `zendesk.getTicketMetrics()` | — | 4 | List Ticket Metrics from Zendesk |
| `get-ticket-related` | `zendesk.getTicketRelated()` | `--ticket-id` | 0 | Get related information for a specific Zendesk ticket |
| `get-ticket-skips` | `zendesk.getTicketSkips()` | `--ticket-id` | 1 | List ticket skips for a specific ticket from Zendesk |
| `get-tickets-audits` | `zendesk.getTicketsAudits()` | `--ticket-id` | 10 | List all audits (change history) for a specific Zendesk ticket |
| `get-tickets-audits-count` | `zendesk.getTicketsAuditsCount()` | `--ticket-id` | 0 | Count audits for a specific ticket in Zendesk |
| `get-tickets-comments-count` | `zendesk.getTicketsCommentsCount()` | `--ticket-id` | 0 | Count comments on a Zendesk ticket |
| `get-tickets-conversation-log` | `zendesk.getTicketsConversationLog()` | `--ticket-id` | 4 | List conversation log events for a specific Zendesk ticket |
| `get-tickets-count` | `zendesk.getTicketsCount()` | — | 0 | Count the number of tickets in Zendesk |
| `get-tickets-metrics` | `zendesk.getTicketsMetrics()` | `--ticket-id` | 0 | Get ticket metrics from Zendesk for a specific ticket |
| `get-tickets-side-conversation-id` | `zendesk.getTicketsSideConversationId()` | `--side-conversation-id` `--ticket-id` | 0 | Get a specific side conversation by its ID for a Zendesk ticket |
| `get-tickets-side-conversations-events` | `zendesk.getTicketsSideConversationsEvents()` | `--side-conversation-id` `--ticket-id` | 0 | List all events for a specific side conversation on a Zendesk ticket |
| `get-tickets-tags` | `zendesk.getTicketsTags()` | `--ticket-id` | 0 | List all tags associated with a specific Zendesk ticket |
| `get-trigger` | `zendesk.getTrigger()` | `--trigger-id` | 0 | Show a specific trigger by its ID |
| `get-trigger-categories` | `zendesk.getTriggerCategories()` | — | 3 | List all ticket trigger categories in your Zendesk account |
| `get-trigger-categories2` | `zendesk.getTriggerCategories2()` | `--trigger-category-id` | 0 | Show a specific ticket trigger category by its ID |
| `get-triggers` | `zendesk.getTriggers()` | — | 8 | List all ticket triggers for the current Zendesk account |
| `get-triggers-definitions` | `zendesk.getTriggersDefinitions()` | — | 0 | Get Ticket Trigger Action and Condition Definitions |
| `get-triggers-search` | `zendesk.getTriggersSearch()` | — | 7 | Search for Zendesk ticket triggers by their title |
| `get-user` ·common | `zendesk.getUser()` | `--user-id` | 0 | Fetch a single Zendesk user by numeric user_id |
| `get-user-entitlements-full` | `zendesk.getUserEntitlementsFull()` | `--user-id` | 0 | Retrieve full entitlements for a Zendesk user across all products (Chat, Explore, Talk, Guide) |
| `get-user-events` | `zendesk.getUserEvents()` | `--user-id` | 5 | Retrieve event history for a specific Zendesk user |
| `get-user-field-by-id` | `zendesk.getUserFieldById()` | `--user-field-id` | 0 | Retrieve a single Zendesk user field by its numeric ID |
| `get-user-field-options` | `zendesk.getUserFieldOptions()` | `--user-field-id` | 2 | List custom user field options for a given user field |
| `get-user-fields` | `zendesk.getUserFields()` | — | 4 | List all custom user fields configured in your Zendesk account |
| `get-user-fields-show-many` | `zendesk.getUserFieldsShowMany()` | — | 1 | Retrieve multiple Zendesk user fields by their keys |
| `get-user-profiles-events2` | `zendesk.getUserProfilesEvents2()` | `--profile-id` | 5 | Get events for a Sunshine profile by its profile ID |
| `get-user-profiles2` | `zendesk.getUserProfiles2()` | `--profile-id` | 0 | Retrieve a single Zendesk user profile by its Sunshine profile ID |
| `get-user-sessions` | `zendesk.getUserSessions()` | `--user-id` | 4 | List all sessions for a specific Zendesk user |
| `get-user-tickets-assigned-count` | `zendesk.getUserTicketsAssignedCount()` | `--user-id` | 0 | Count tickets assigned to a specific user in Zendesk |
| `get-users-assigned-tickets` ·common | `zendesk.getUsersAssignedTickets()` | `--user-id` | 4 | List tickets assigned to a specific Zendesk user |
| `get-users-autocomplete` | `zendesk.getUsersAutocomplete()` | — | 7 | Autocomplete users by name or phone number |
| `get-users-brand-agents` | `zendesk.getUsersBrandAgents()` | `--user-id` | 3 | List brand agent memberships for a specific user in Zendesk |
| `get-users-ccd-tickets` ·common | `zendesk.getUsersCcdTickets()` | `--user-id` | 4 | List tickets where a specific Zendesk user is CC'd (carbon copied) |
| `get-users-compliance-deletion-statuses` | `zendesk.getUsersComplianceDeletionStatuses()` | `--user-id` | 3 | Fetch GDPR compliance deletion statuses for a specific Zendesk user |
| `get-users-count` | `zendesk.getUsersCount()` | — | 3 | Count users in Zendesk |
| `get-users-followed-tickets` ·common | `zendesk.getUsersFollowedTickets()` | `--user-id` | 5 | List tickets the specified Zendesk user is following |
| `get-users-group-memberships` | `zendesk.getUsersGroupMemberships()` | `--user-id` | 7 | List group memberships for a specific Zendesk user |
| `get-users-group-memberships-by-id` | `zendesk.getUsersGroupMembershipsById()` | `--group-membership-id` `--user-id` | 0 | Get a specific group membership for a user by their IDs |
| `get-users-groups` | `zendesk.getUsersGroups()` | `--user-id` | 6 | List all groups that a specific Zendesk user belongs to |
| `get-users-groups-count` | `zendesk.getUsersGroupsCount()` | `--user-id` | 0 | Count user groups in Zendesk |
| `get-users-identities2` | `zendesk.getUsersIdentities2()` | `--user-id` `--user-identity-id` | 0 | Show a specific user identity by user ID and identity ID |
| `get-users-me-session` | `zendesk.getUsersMeSession()` | — | 2 | Show the currently authenticated session in Zendesk |
| `get-users-me-settings` | `zendesk.getUsersMeSettings()` | — | 0 | Get the settings for the currently authenticated user in Zendesk |
| `get-users-organization-memberships` | `zendesk.getUsersOrganizationMemberships()` | `--user-id` | 1 | List organization memberships for a specific Zendesk user |
| `get-users-organization-memberships2` | `zendesk.getUsersOrganizationMemberships2()` | `--organization-membership-id` `--user-id` | 0 | Get details for a specific organization membership by user ID and membership ID |
| `get-users-organization-subscriptions` | `zendesk.getUsersOrganizationSubscriptions()` | `--user-id` | 5 | List User's Organization Subscriptions - retrieves organization subscriptions for a specific user |
| `get-users-organizations` | `zendesk.getUsersOrganizations()` | `--user-id` | 3 | List organizations associated with a specific Zendesk user |
| `get-users-organizations-count` | `zendesk.getUsersOrganizationsCount()` | `--user-id` | 0 | Returns an approximate count of organizations that a user belongs to |
| `get-users-password-requirements` | `zendesk.getUsersPasswordRequirements()` | `--user-id` | 0 | Get password requirements for a specific Zendesk user |
| `get-users-profiles` | `zendesk.getUsersProfiles()` | `--user-id` | 0 | Retrieve profiles associated with a specific Zendesk user by user ID |
| `get-users-related` | `zendesk.getUsersRelated()` | `--user-id` | 0 | Get related counts and information for a specific Zendesk user by ID |
| `get-users-requested-tickets` ·common | `zendesk.getUsersRequestedTickets()` | `--user-id` | 4 | List tickets requested by a specific Zendesk user |
| `get-users-requests` | `zendesk.getUsersRequests()` | `--user-id` | 2 | List ticket requests for a specific Zendesk user |
| `get-users-skips` | `zendesk.getUsersSkips()` | `--user-id` | 3 | List ticket skips for a specific user from Zendesk |
| `get-users-tags` | `zendesk.getUsersTags()` | `--user-id` | 0 | List all tags assigned to a specific Zendesk user |
| `get-view-definitions` | `zendesk.getViewDefinitions()` | — | 0 | List the definitions of the conditions and actions available for constructing views in Zendesk |
| `get-view-ticket-count` | `zendesk.getViewTicketCount()` | `--view-id` | 0 | Count tickets in a specific view in Zendesk |
| `get-views` | `zendesk.getViews()` | — | 8 | List shared and personal views available to the current user in Zendesk |
| `get-views-active` | `zendesk.getViewsActive()` | — | 6 | List all active shared and personal views available in Zendesk |
| `get-views-compact` | `zendesk.getViewsCompact()` | — | 0 | Retrieves a compacted list of shared and personal views available to the current user in Zendesk |
| `get-views-count` | `zendesk.getViewsCount()` | — | 0 | Count shared and personal views in Zendesk |
| `get-views-count-many` | `zendesk.getViewsCountMany()` | `--ids` | 0 | Count tickets in multiple Zendesk views |
| `get-views-execute` | `zendesk.getViewsExecute()` | `--view-id` | 6 | Execute a Zendesk view to retrieve its column titles and matching ticket rows |
| `get-views-export` | `zendesk.getViewsExport()` | `--view-id` | 0 | Export a Zendesk view as a CSV file |
| `get-views-search` | `zendesk.getViewsSearch()` | `--query` | 8 | Search for Zendesk views by their title |
| `get-views-show-many` | `zendesk.getViewsShowMany()` | `--ids` | 1 | Get multiple Zendesk views by their IDs |
| `get-views-tickets` | `zendesk.getViewsTickets()` | `--view-id` | 5 | List tickets from a specific Zendesk view |
| `list-access-rules` | `zendesk.listAccessRules()` | `--custom-object-key` | 0 | List all access rules for a Zendesk custom object |
| `list-active-automations` | `zendesk.listActiveAutomations()` | — | 5 | List all active automations in Zendesk |
| `list-app-installations` | `zendesk.listAppInstallations()` | — | 3 | List all app installations in the Zendesk account |
| `list-app-locations` | `zendesk.listAppLocations()` | — | 0 | List all available locations where Zendesk apps can be installed |
| `list-assignable-group-memberships` | `zendesk.listAssignableGroupMemberships()` | — | 4 | List assignable group memberships in Zendesk |
| `list-assignable-group-memberships-by-group` | `zendesk.listAssignableGroupMembershipsByGroup()` | `--group-id` | 4 | List assignable group memberships for a specific group in Zendesk |
| `list-bookmarks` | `zendesk.listBookmarks()` | — | 2 | List Bookmarks returns all bookmarks created by the user |
| `list-brand-agents` | `zendesk.listBrandAgents()` | — | 3 | List brand agent memberships to retrieve which agents are associated with which brands in Zendesk |
| `list-custom-object-fields` | `zendesk.listCustomObjectFields()` | `--custom-object-key` | 3 | List all fields for a custom object in Zendesk |
| `list-custom-object-record-attachments` | `zendesk.listCustomObjectRecordAttachments()` | `--custom-object-key` `--record-id` | 0 | List all file attachments for a specific custom object record in Zendesk |
| `list-custom-object-records` | `zendesk.listCustomObjectRecords()` | `--custom-object-key` | 6 | List all records for a specific custom object type in Zendesk |
| `list-custom-objects` | `zendesk.listCustomObjects()` | — | 1 | List all custom object definitions in Zendesk |
| `list-deleted-users` | `zendesk.listDeletedUsers()` | — | 3 | List deleted users in Zendesk via the Users API |
| `list-incremental-custom-object-records` | `zendesk.listIncrementalCustomObjectRecords()` | `--custom-object-key` | 4 | Export custom object records incrementally using cursor-based pagination |
| `list-monitored-twitter-handles` | `zendesk.listMonitoredTwitterHandles()` | — | 2 | List all monitored X (Twitter) handles configured in your Zendesk account |
| `list-object-triggers` | `zendesk.listObjectTriggers()` | `--custom-object-key` | 5 | List all triggers for a specific custom object in Zendesk |
| `list-object-triggers-definitions` | `zendesk.listObjectTriggersDefinitions()` | `--custom-object-key` | 0 | List Object Trigger Action and Condition Definitions for a custom object in Zendesk |
| `list-organization-memberships` | `zendesk.listOrganizationMemberships()` | — | 4 | List organization memberships in Zendesk |
| `list-organization-memberships-by-organization` | `zendesk.listOrganizationMembershipsByOrganization()` | `--organization-id` | 4 | List organization memberships for a specific organization in Zendesk |
| `list-permission-policies` | `zendesk.listPermissionPolicies()` | `--custom-object-key` | 0 | List all permission policies for a custom object in Zendesk |
| `list-resource-collections` | `zendesk.listResourceCollections()` | — | 1 | List Resource Collections for the Zendesk account |
| `list-skips` | `zendesk.listSkips()` | — | 3 | Lists all ticket skips in Zendesk |
| `list-support-addresses` | `zendesk.listSupportAddresses()` | — | 4 | List all support addresses (recipient addresses) configured in your Zendesk account |
| `list-ticket-audits` | `zendesk.listTicketAudits()` | — | 3 | List all ticket audits from Zendesk |
| `list-ticket-content-pins` | `zendesk.listTicketContentPins()` | `--ticket-id` | 0 | List Ticket Content Pins returns all content pins for a specified ticket |
| `list-tickets` ·common | `zendesk.listTickets()` | — | 8 | List Zendesk tickets with pagination and filtering |
| `list-user-identities` | `zendesk.listUserIdentities()` | `--user-id` | 5 | List all identities for a specific Zendesk user |
| `list-users` ·common | `zendesk.listUsers()` | — | 8 | List/enumerate Zendesk users via the Users API |
| `make-comment-private` | `zendesk.makeCommentPrivate()` | `--ticket-comment-id` `--ticket-id` | 0 | Make a public ticket comment private in Zendesk |
| `make-default-organization-membership` | `zendesk.makeDefaultOrganizationMembership()` | `--organization-membership-id` `--user-id` | 0 | Set a specific organization membership as the default for a user in Zendesk |
| `make-end-user-identity-primary` | `zendesk.makeEndUserIdentityPrimary()` | `--user-id` `--user-identity-id` | 0 | Set a specified identity as the primary identity for an end user in Zendesk |
| `make-ticket-comment-private` | `zendesk.makeTicketCommentPrivate()` | `--ticket-audit-id` `--ticket-id` | 0 | Change a public comment to private on a Zendesk ticket audit |
| `make-user-identity-primary` | `zendesk.makeUserIdentityPrimary()` | `--user-id` `--user-identity-id` | 0 | Set a user identity as the primary identity for a Zendesk user |
| `mark-many-tickets-as-spam` | `zendesk.markManyTicketsAsSpam()` | `--ids` | 0 | Marks multiple tickets as spam in Zendesk |
| `merge-tickets` | `zendesk.mergeTickets()` | `--source-ticket-ids` `--target-ticket-id` | 4 | Merges multiple tickets into a target ticket in Zendesk |
| `merge-users` ·common | `zendesk.mergeUsers()` | `--user` `--user-id` | 0 | Merges two Zendesk end users together |
| `open-users-profile-in-agent-browser` | `zendesk.openUsersProfileInAgentBrowser()` | `--agent-id` `--user-id` | 0 | Open a Zendesk user's profile in a specified agent's browser |
| `recover-many-suspended-tickets` | `zendesk.recoverManySuspendedTickets()` | `--ids` | 0 | Recover multiple suspended tickets in Zendesk |
| `renew-session` | `zendesk.renewSession()` | — | 0 | Renew the current Zendesk session and obtain a new authenticity token |
| `reorder-custom-object-fields` | `zendesk.reorderCustomObjectFields()` | `--custom-object-field-ids` `--custom-object-key` | 0 | Reorder Custom Fields of an Object |
| `reorder-location-installations` | `zendesk.reorderLocationInstallations()` | `--installations` `--location-name` | 0 | Reorder App Installations For Location |
| `reorder-organization-fields` | `zendesk.reorderOrganizationFields()` | `--organization-field-ids` | 0 | Reorder Organization Fields |
| `reorder-ticket-fields` | `zendesk.reorderTicketFields()` | `--ticket-field-ids` | 0 | Reorder Ticket Fields |
| `reorder-triggers` | `zendesk.reorderTriggers()` | `--trigger-ids` | 0 | Reorder Ticket Triggers |
| `reorder-user-fields` | `zendesk.reorderUserFields()` | `--user-field-ids` | 0 | Reorder User Fields |
| `reply-ticket` | `zendesk.replyTicket()` | `--ticket-id` | 3 | Action to reply to a Zendesk ticket by adding a comment |
| `request-end-user-verification` | `zendesk.requestEndUserVerification()` | `--user-id` `--user-identity-id` | 0 | Send a verification email to an end user to verify ownership of their email address identity |
| `request-user-create` | `zendesk.requestUserCreate()` | `--user` | 0 | Send a request to create a user in Zendesk |
| `request-user-verification` | `zendesk.requestUserVerification()` | `--user-id` `--user-identity-id` | 0 | Send a verification email to a user to verify ownership of their email address identity |
| `restore-many-tickets` | `zendesk.restoreManyTickets()` | `--ids` | 0 | Restores multiple previously deleted tickets in Zendesk |
| `restore-ticket` | `zendesk.restoreTicket()` | `--ticket-id` | 0 | Restores a previously deleted ticket in Zendesk |
| `search-custom-object-records` | `zendesk.searchCustomObjectRecords()` | `--custom-object-key` | 6 | Search and filter custom object records in Zendesk using text queries and field filters |
| `search-object-triggers` | `zendesk.searchObjectTriggers()` | `--custom-object-key` | 7 | Search for triggers associated with a custom object in Zendesk |
| `search-organizations` | `zendesk.searchOrganizations()` | — | 2 | Search organizations in Zendesk by external ID or name |
| `search-users` | `zendesk.searchUsers()` | — | 5 | Search for Zendesk users by query or external ID |
| `search-zendesk` ·common | `zendesk.searchZendesk()` | `--query` | 5 | Search for tickets, users, organizations, and groups in Zendesk using query syntax |
| `set-default-custom-status` | `zendesk.setDefaultCustomStatus()` | `--ids` | 0 | Sets one or more custom ticket statuses as the default for their respective categories |
| `set-group-membership-as-default` | `zendesk.setGroupMembershipAsDefault()` | `--group-membership-id` `--user-id` | 0 | Set a group membership as the default for a specific user in Zendesk |
| `set-users-organization-as-default` | `zendesk.setUsersOrganizationAsDefault()` | `--organization-id` `--user-id` | 0 | Set an organization as the default for a user in Zendesk |
| `show-access-rule` | `zendesk.showAccessRule()` | `--custom-object-key` `--id` | 0 | Show a custom object access rule by its ID |
| `show-custom-object` | `zendesk.showCustomObject()` | `--custom-object-key` | 2 | Get details of a specific Zendesk custom object by its key |
| `show-custom-object-record` | `zendesk.showCustomObjectRecord()` | `--custom-object-key` `--custom-object-record-id` | 0 | Get details of a specific Zendesk custom object record by its key and record ID |
| `show-many-job-statuses` | `zendesk.showManyJobStatuses()` | `--ids` | 0 | Show many job statuses by their IDs in Zendesk |
| `show-many-tickets` | `zendesk.showManyTickets()` | `--ids` | 1 | Show multiple tickets by their IDs |
| `show-many-users` | `zendesk.showManyUsers()` | — | 4 | Retrieve multiple Zendesk users by their numeric IDs or external IDs |
| `show-permission-policy` | `zendesk.showPermissionPolicy()` | `--custom-object-key` `--id` | 0 | Get details of a specific permission policy for a Zendesk custom object by its ID |
| `show-request` | `zendesk.showRequest()` | `--request-id` | 0 | Show a single request in Zendesk |
| `unassign-user-organization` | `zendesk.unassignUserOrganization()` | `--organization-id` `--user-id` | 0 | Immediately removes a user from an organization in Zendesk |
| `update-access-rule` | `zendesk.updateAccessRule()` | `--custom-object-key` `--id` | 3 | Update an existing access rule for a custom object in Zendesk |
| `update-account-settings` | `zendesk.updateAccountSettings()` | `--settings` | 0 | Update Zendesk account-level settings including tickets, branding, localization, routing, and more |
| `update-apps-installation` | `zendesk.updateAppsInstallation()` | `--app-installation-id` | 5 | Update an app installation in Zendesk |
| `update-attachment` | `zendesk.updateAttachment()` | `--attachment-id` `--malware-access-override` | 0 | Updates an attachment's malware access override setting |
| `update-automation` | `zendesk.updateAutomation()` | `--automation-id` | 5 | Update an existing automation in Zendesk |
| `update-custom-object` | `zendesk.updateCustomObject()` | `--custom-object-key` | 6 | Update an existing custom object in Zendesk |
| `update-custom-object-field` | `zendesk.updateCustomObjectField()` | `--custom-object-field-key-or-id` `--custom-object-key` | 6 | Update an existing custom object field in Zendesk |
| `update-custom-object-record` | `zendesk.updateCustomObjectRecord()` | `--custom-object-key` `--custom-object-record-id` | 3 | Update an existing record for a custom object in Zendesk |
| `update-custom-status` | `zendesk.updateCustomStatus()` | `--custom-status-id` | 5 | Update an existing custom ticket status in Zendesk |
| `update-deletion-schedule` | `zendesk.updateDeletionSchedule()` | `--deletion-schedule-id` | 4 | Update an existing deletion schedule in Zendesk |
| `update-dynamic-content-item` | `zendesk.updateDynamicContentItem()` | `--dynamic-content-item-id` `--name` | 0 | Update a dynamic content item in Zendesk |
| `update-dynamic-content-items-variant` | `zendesk.updateDynamicContentItemsVariant()` | `--content` `--dynamic-content-item-id` `--dynamic-content-variant-id` `--locale-id` | 2 | Update a single variant of a dynamic content item in Zendesk |
| `update-dynamic-content-items-variants` | `zendesk.updateDynamicContentItemsVariants()` | `--dynamic-content-item-id` `--variants` | 0 | Update one or more variants of a dynamic content item in Zendesk |
| `update-macro` | `zendesk.updateMacro()` | `--actions` `--macro-id` `--title` | 3 | Update an existing macro in Zendesk |
| `update-many-automations` | `zendesk.updateManyAutomations()` | `--automations` | 0 | Update multiple automations in Zendesk in a single request |
| `update-many-macros` | `zendesk.updateManyMacros()` | `--macros` | 0 | Update multiple macros in Zendesk in a single request |
| `update-many-object-triggers` | `zendesk.updateManyObjectTriggers()` | `--custom-object-key` `--triggers` | 0 | Update multiple custom object triggers in Zendesk in a single request |
| `update-many-organizations` | `zendesk.updateManyOrganizations()` | `--organizations` | 2 | Bulk update multiple Zendesk organizations in a single request |
| `update-many-tickets` | `zendesk.updateManyTickets()` | `--tickets` | 1 | Update multiple tickets in Zendesk in a single request |
| `update-many-triggers` | `zendesk.updateManyTriggers()` | `--triggers` | 0 | Update multiple ticket triggers in Zendesk in a single request |
| `update-many-users` | `zendesk.updateManyUsers()` | — | 4 | Bulk update multiple Zendesk users in a single request |
| `update-many-views` | `zendesk.updateManyViews()` | `--views` | 0 | Update multiple views in Zendesk in a single request |
| `update-object-trigger` | `zendesk.updateObjectTrigger()` | `--custom-object-key` `--trigger-id` | 5 | Update an existing custom object trigger in Zendesk |
| `update-organization` | `zendesk.updateOrganization()` | `--data` `--organization-id` | 0 | Update an organization in Zendesk |
| `update-organization-field` | `zendesk.updateOrganizationField()` | `--key` `--organization-field-id` `--title` `--type` | 8 | Update a custom organization field in Zendesk |
| `update-organizations-tags` | `zendesk.updateOrganizationsTags()` | `--organization-id` `--tags` | 0 | Add organization tags in Zendesk |
| `update-permission-policy` | `zendesk.updatePermissionPolicy()` | `--custom-object-key` `--id` | 1 | Update an existing permission policy for a custom object in Zendesk |
| `update-requests` | `zendesk.updateRequests()` | `--request-id` | 8 | Update a ticket request in Zendesk with a comment or collaborators |
| `update-resource-collection` | `zendesk.updateResourceCollection()` | `--resource-collection-id` | 2 | Update an existing resource collection in Zendesk |
| `update-side-conversation` | `zendesk.updateSideConversation()` | `--side-conversation-id` `--ticket-id` | 2 | Update a side conversation on a ticket in Zendesk |
| `update-support-address` | `zendesk.updateSupportAddress()` | `--support-address-id` | 3 | Update an existing support address in Zendesk |
| `update-target` | `zendesk.updateTarget()` | `--target-id` | 3 | Update an existing target in Zendesk |
| `update-ticket` | `zendesk.updateTicket()` | `--ticket-id` | 23 | Update a ticket in Zendesk |
| `update-ticket-field` | `zendesk.updateTicketField()` | `--ticket-field-id` | 16 | Update an existing ticket field in Zendesk |
| `update-ticket-trigger` | `zendesk.updateTicketTrigger()` | `--trigger-id` | 7 | Update an existing ticket trigger in Zendesk |
| `update-tickets-tags` | `zendesk.updateTicketsTags()` | `--tags` `--ticket-id` | 0 | Update tags on a Zendesk ticket via PUT request to /api/v2/tickets/{ticket_id}/tags |
| `update-trigger-category` | `zendesk.updateTriggerCategory()` | `--trigger-category-id` | 2 | Update an existing trigger category in Zendesk |
| `update-user-field` | `zendesk.updateUserField()` | `--user-field-id` | 11 | Update an existing user field in Zendesk |
| `update-user-profile` | `zendesk.updateUserProfile()` | `--identifier` | 5 | Partially updates a user profile in Zendesk by identifier |
| `update-user-profile-by-id` | `zendesk.updateUserProfileById()` | `--profile-id` | 5 | Partially updates a user profile in Zendesk by profile ID |
| `update-users-identity` | `zendesk.updateUsersIdentity()` | `--user-id` `--user-identity-id` | 1 | Update a user identity in Zendesk |
| `update-users-me-settings` | `zendesk.updateUsersMeSettings()` | `--settings` | 0 | Update the settings for the currently authenticated Zendesk user |
| `update-users-profiles` | `zendesk.updateUsersProfiles()` | `--identifier` `--profile` `--user-id` | 0 | Create or update a user profile for a specific Zendesk user by user ID and identifier |
| `update-users-tags` | `zendesk.updateUsersTags()` | `--tags` `--user-id` | 0 | Update (replace) tags for a specific Zendesk user |
| `update-view` | `zendesk.updateView()` | `--view-id` | 5 | Update an existing view in Zendesk |
| `upsert-custom-object-record-by-external-id-or-name` | `zendesk.upsertCustomObjectRecordByExternalIdOrName()` | `--custom-object-key` | 3 | Create or update a custom object record in Zendesk by external_id or name |
| `verify-subdomain-availability` | `zendesk.verifySubdomainAvailability()` | `--subdomain` | 0 | Verify if a subdomain name is available for use in Zendesk |
| `verify-support-address` | `zendesk.verifySupportAddress()` | `--support-address-id` | 0 | Verify a support address forwarding in Zendesk |
| `verify-user-identity` | `zendesk.verifyUserIdentity()` | `--user-id` `--user-identity-id` | 0 | Set a user identity as verified in Zendesk |

## Triggers

`zendesk.on("<event>", handler)` in a script; required config goes before the handler as an object.

| Event | Name | Required config | Description |
|---|---|---|---|
| `"new-user"` | New User Created | `name` `events` | Triggered when a new user is created in Zendesk |
| `"new-ticket"` | New Zendesk Ticket | — | Triggers when a new ticket is created in a specified Zendesk view |

## Docs

- [run CLI](https://docs.boxd.sh/cli/run): Call connected integrations from the shell, connect new ones, and run automations.
- [Quickstart](https://docs.boxd.sh/guides/integrations/quickstart): Connect an integration, call it from the shell, and turn a script into an automation.
- [Connections](https://docs.boxd.sh/guides/integrations/connections): Connect an account once, for yourself or for your whole organization.
- [Scripts](https://docs.boxd.sh/guides/automations/scripts): Typed integrations, triggers, schedules and state in a .run.ts file.
- [Jobs](https://docs.boxd.sh/guides/automations/jobs): How a script becomes a background job: states, retries, sleep and wake.
- [Beyond the catalog](https://docs.boxd.sh/guides/automations/beyond-the-catalog): Reach your own APIs, databases and cloud accounts from a script.