Zendesk

Zendesk node reference - all 145 operations, the credential it needs, and a worked example.

Zendesk Support. Tickets (create, read, search, update, merge, bulk, delete and restore), comments, audits and metrics, attachments and uploads, tags, users and their identities, organizations and memberships, groups, end-user requests, unified search and export, macros and views, satisfaction ratings, ticket fields and forms, custom object records, and bulk job statuses.

Credential: Zendesk email:apiToken - see Credentials.

Scopes

Each operation below lists the scope it needs. Scopes are the OAuth scope an OAuth app would request. Pipory's Zendesk credential is an email/API-token pair, which carries the calling AGENT'S ROLE rather than a scope subset - so a refusal means that agent's role is insufficient, and some operations are admin-only whatever the token. If a run fails with a permission error, the node names the missing scope in the error - grant it and re-run; you do not need to rebuild the workflow.

Operations (145)

Tickets — read

Operation	What it does	Scope
`getTicket`	Get ticket	`tickets:read`
`listTickets`	List tickets	`tickets:read`
`getManyTickets`	Get many tickets by ID	`tickets:read`
`countTickets`	Count tickets	`tickets:read`
`listRecentTickets`	List recently viewed tickets	`tickets:read`
`listOrganizationTickets`	List an organization's tickets	`tickets:read`
`listUserRequestedTickets`	List tickets a user requested	`tickets:read`
`listUserAssignedTickets`	List tickets assigned to a user	`tickets:read`
`listUserCcdTickets`	List tickets a user is CC'd on	`tickets:read`
`listUserFollowedTickets`	List tickets a user follows	`tickets:read`
`listTicketIncidents`	List incidents linked to a problem	`tickets:read`
`getTicketRelated`	Get ticket related information	`tickets:read`
`listTicketCollaborators`	List ticket collaborators	`tickets:read`
`listTicketFollowers`	List ticket followers	`tickets:read`
`listTicketEmailCcs`	List ticket email CCs	`tickets:read`

Tickets — write

Operation	What it does	Scope
`createTicket`	Create ticket	`tickets:write`
`updateTicket`	Update ticket	`tickets:write`
`createManyTickets`	Create many tickets	`tickets:write`
`updateManyTickets`	Update many tickets	`tickets:write`
`deleteTicket`	Delete ticket	`tickets:write`
`deleteManyTickets`	Delete many tickets	`tickets:write`
`mergeTickets`	Merge tickets into a target ticket	`tickets:write`
`markTicketAsSpam`	Mark ticket as spam and suspend requester	`tickets:write`
`markManyTicketsAsSpam`	Mark many tickets as spam	`tickets:write`
`importTicket`	Import ticket (backdated)	`tickets:write`
`listDeletedTickets`	List deleted tickets	`tickets:read`
`restoreDeletedTicket`	Restore a deleted ticket	`tickets:write`
`restoreManyDeletedTickets`	Restore many deleted tickets	`tickets:write`

Comments, audits and metrics

Operation	What it does	Scope
`addComment`	Add comment to ticket	`tickets:write`
`listTicketComments`	List ticket comments	`tickets:read`
`countTicketComments`	Count ticket comments	`tickets:read`
`makeCommentPrivate`	Make a comment private	`tickets:write`
`listTicketAudits`	List a ticket's audits	`tickets:read`
`getTicketAudit`	Get ticket audit	`tickets:read`
`listAllTicketAudits`	List all audits (account-wide)	`tickets:read`
`getTicketMetrics`	Get a ticket's metrics	`tickets:read`
`listTicketMetrics`	List ticket metrics	`tickets:read`

Attachments

Operation	What it does	Scope
`uploadAttachment`	Upload a file (get an attachment token)	`tickets:write`
`deleteUpload`	Delete an upload	`tickets:write`
`getAttachment`	Get attachment	`tickets:read`
`deleteAttachment`	Delete attachment	`tickets:write`

Operation	What it does	Scope
`listTags`	List account tags	`read`
`countTags`	Count account tags	`read`
`autocompleteTags`	Autocomplete tags	`read`
`listTicketTags`	List a ticket's tags	`tickets:read`
`addTicketTags`	Add tags to a ticket	`tickets:write`
`setTicketTags`	Set (replace) a ticket's tags	`tickets:write`
`removeTicketTags`	Remove tags from a ticket	`tickets:write`
`addUserTags`	Add tags to a user	`users:write`
`removeUserTags`	Remove tags from a user	`users:write`
`addOrganizationTags`	Add tags to an organization	`organizations:write`
`removeOrganizationTags`	Remove tags from an organization	`organizations:write`

Users

Operation	What it does	Scope
`getUser`	Get user	`users:read`
`listUsers`	List users	`users:read`
`getManyUsers`	Get many users by ID	`users:read`
`getCurrentUser`	Get the authenticated user	`users:read`
`searchUsers`	Search users	`users:read`
`autocompleteUsers`	Autocomplete users by name	`users:read`
`countUsers`	Count users	`users:read`
`getUserRelated`	Get user related information	`users:read`
`createUser`	Create user	`users:write`
`createOrUpdateUser`	Create or update user (upsert)	`users:write`
`createManyUsers`	Create many users	`users:write`
`createOrUpdateManyUsers`	Create or update many users	`users:write`
`updateUser`	Update user	`users:write`
`mergeUsers`	Merge one end user into another	`users:write`
`deleteUser`	Delete user	`users:write`
`deleteManyUsers`	Delete many users	`users:write`
`listUserOrganizations`	List a user's organizations	`organizations:read`
`listUserGroups`	List a user's groups	`read`

User identities

Operation	What it does	Scope
`listUserIdentities`	List a user's identities	`users:read`
`getUserIdentity`	Get user identity	`users:read`
`createUserIdentity`	Add an identity to a user	`users:write`
`updateUserIdentity`	Update user identity	`users:write`
`makeIdentityPrimary`	Make an identity primary	`users:write`
`verifyUserIdentity`	Verify an identity	`users:write`
`deleteUserIdentity`	Delete user identity	`users:write`

Organizations

Operation	What it does	Scope
`getOrganization`	Get organization	`organizations:read`
`listOrganizations`	List organizations	`organizations:read`
`getManyOrganizations`	Get many organizations by ID	`organizations:read`
`searchOrganizations`	Search organizations by name or external ID	`organizations:read`
`autocompleteOrganizations`	Autocomplete organizations by name	`organizations:read`
`getOrganizationRelated`	Get organization related information	`organizations:read`
`countOrganizations`	Count organizations	`organizations:read`
`createOrganization`	Create organization	`organizations:write`
`createOrUpdateOrganization`	Create or update organization (upsert)	`organizations:write`
`createManyOrganizations`	Create many organizations	`organizations:write`
`updateOrganization`	Update organization	`organizations:write`
`deleteOrganization`	Delete organization	`organizations:write`
`mergeOrganizations`	Merge an organization into another	`organizations:write`
`listOrganizationUsers`	List an organization's users	`users:read`

Organization memberships

Operation	What it does	Scope
`listOrganizationMemberships`	List organization memberships	`organizations:read`
`createOrganizationMembership`	Add a user to an organization	`organizations:write`
`deleteOrganizationMembership`	Remove a user from an organization	`organizations:write`
`setDefaultOrganization`	Set a user's default organization	`organizations:write`

Groups

Operation	What it does	Scope
`listGroups`	List groups	`read`
`listAssignableGroups`	List assignable groups	`read`
`getGroup`	Get group	`read`
`createGroup`	Create group	`write`
`updateGroup`	Update group	`write`
`deleteGroup`	Delete group	`write`
`listGroupMemberships`	List group memberships	`read`
`createGroupMembership`	Add an agent to a group	`write`
`listAvailableAgents`	List available agents	`read`

Requests (end-user facing)

Operation	What it does	Scope
`listRequests`	List requests	`requests:read`
`searchRequests`	Search requests	`requests:read`
`getRequest`	Get request	`requests:read`
`createRequest`	Create request	`requests:write`
`updateRequest`	Update request (comment or solve)	`requests:write`
`listRequestComments`	List a request's comments	`requests:read`

Search

Operation	What it does	Scope
`search`	Search everything (Zendesk query syntax)	`read`
`searchTickets`	Search tickets	`read`
`countSearchResults`	Count search results	`read`
`exportSearchResults`	Export search results (cursor, >1000)	`read`

Macros and views

Operation	What it does	Scope
`listMacros`	List macros	`macros:read`
`listActiveMacros`	List active macros	`macros:read`
`getMacro`	Get macro	`macros:read`
`searchMacros`	Search macros	`macros:read`
`listMacroCategories`	List macro categories	`macros:read`
`previewMacroChanges`	Preview a macro's changes	`macros:read`
`applyMacroToTicket`	Apply a macro to a ticket	`macros:read`
`listViews`	List views	`read`
`getView`	Get view	`read`
`executeView`	Execute a view (columns and rows)	`read`
`listViewTickets`	List tickets in a view	`read`
`countViewTickets`	Count tickets in a view	`read`
`searchViews`	Search views	`read`

Satisfaction, fields and forms

Operation	What it does	Scope
`submitSatisfactionRating`	Submit a satisfaction rating	`satisfaction_ratings:write`
`listSatisfactionRatings`	List satisfaction ratings	`satisfaction_ratings:read`
`getSatisfactionRating`	Get satisfaction rating	`satisfaction_ratings:read`
`listTicketFields`	List ticket fields	`tickets:read`
`getTicketField`	Get ticket field	`tickets:read`
`listTicketFieldOptions`	List a ticket field's options	`tickets:read`
`listTicketForms`	List ticket forms	`tickets:read`
`getTicketForm`	Get ticket form	`tickets:read`

Custom objects

Operation	What it does	Scope
`listCustomObjects`	List custom objects	`read`
`listCustomObjectRecords`	List custom object records	`read`
`getCustomObjectRecord`	Get custom object record	`read`
`createCustomObjectRecord`	Create custom object record	`write`
`updateCustomObjectRecord`	Update custom object record	`write`
`upsertCustomObjectRecord`	Create or update record by external ID	`write`
`deleteCustomObjectRecord`	Delete custom object record	`write`
`searchCustomObjectRecords`	Search custom object records	`read`

Jobs

Operation	What it does	Scope
`getJobStatus`	Get job status	`read`
`listJobStatuses`	List job statuses	`read`

Example

Reply to a ticket publicly, or add a note only agents can see

In Zendesk the difference between answering the customer and leaving an internal note is one boolean on the comment, and getting it wrong is the integration's worst failure mode: a private remark about a customer posted to that customer. The public field is that boolean, and it is worth setting explicitly on every add-comment node rather than relying on a default.

Set Operation to addComment, then fill in:

Field	Value	Notes
`ticketId`	`{{ myTrigger.ticketId }}`	The ticket to answer
`comment`	`Thanks — we've shipped a fix and your account is back to normal.`	The body
`public`	`true`	true is visible to the requester; false is an internal note. Set it explicitly — this is the field that decides who reads it
`status`	`solved`	Optional; moves the ticket in the same request

Sets {{reply.ticketId}}, {{reply.commentId}} and {{reply.ticket}} (the updated ticket, so {{reply.ticket.status}} reflects the move).

On this page