AptlyStar

Zendesk

Manage support tickets, users, and organizations in Zendesk

Zendesk is a leading customer service and support platform that empowers organizations to efficiently manage support tickets, users, and organizations through a robust set of tools and APIs. The Zendesk integration in Aptlystar lets your agents automate key support operations and synchronize your support data with the rest of your workflow.

With Zendesk in Aptlystar, you can:

  • Manage Tickets:

    • Retrieve lists of support tickets with advanced filtering and sorting.
    • Get detailed information on a single ticket for tracking and resolution.
    • Create new tickets individually or in bulk to log customer issues programmatically.
    • Update tickets or apply bulk updates to streamline complex workflows.
    • Delete or merge tickets as cases are resolved or duplicates arise.
  • User Management:

    • Retrieve lists of users or search users by criteria to keep your customer and agent directories up-to-date.
    • Get detailed information on individual users or the current logged-in user.
    • Create new users or onboard them in bulk, automating customer and agent provisioning.
    • Update or bulk update user details to ensure information accuracy.
    • Delete users as needed for privacy or account management.
  • Organization Management:

    • List, search, and autocomplete organizations for streamlined support and account management.
    • Get organization details and keep your database organized.
    • Create, update, or delete organizations to reflect changes in your customer base.
    • Perform bulk organization creation for large onboarding efforts.
  • Advanced Search & Analytics:

    • Use versatile search endpoints to quickly locate tickets, users, or organizations by any field.
    • Retrieve counts of search results to power reporting and analytics.

By leveraging Zendesk’s Aptlystar integration, your automated workflows can seamlessly handle support ticket triage, user onboarding/offboarding, company management, and keep your support operations running smoothly. Whether you’re integrating support with product, CRM, or automation systems, Zendesk tools in Aptlystar provide robust, programmatic control to power best-in-class support at scale.

Usage Instructions

Integrate Zendesk into the workflow. Can get tickets, get ticket, create ticket, create tickets bulk, update ticket, update tickets bulk, delete ticket, merge tickets, get users, get user, get current user, search users, create user, create users bulk, update user, update users bulk, delete user, get organizations, get organization, autocomplete organizations, create organization, create organizations bulk, update organization, delete organization, search, search count.

Tools

zendesk_get_tickets

Retrieve a list of tickets from Zendesk with optional filtering

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain (e.g., "mycompany" for mycompany.zendesk.com)
statusstringNoFilter by status: "new", "open", "pending", "hold", "solved", or "closed"
prioritystringNoFilter by priority: "low", "normal", "high", or "urgent"
typestringNoFilter by type: "problem", "incident", "question", or "task"
assigneeIdstringNoFilter by assignee user ID as a numeric string (e.g., "12345")
organizationIdstringNoFilter by organization ID as a numeric string (e.g., "67890")
sortstringNoSort field for ticket listing (only applies without filters): "updated_at", "id", or "status". Prefix with "-" for descending (e.g., "-updated_at")
perPagestringNoResults per page as a number string (default: "100", max: "100")
pageAfterstringNoCursor from a previous response to fetch the next page of results

Output

ParameterTypeDescription
ticketsarrayArray of ticket objects
↳ idnumberAutomatically assigned ticket ID
↳ urlstringAPI URL of the ticket
↳ external_idstringExternal ID for linking to external records
↳ viaobjectHow the ticket was created
↳ channelstringChannel through which the ticket was created (e.g., email, web, api)
↳ sourceobjectSource details for the channel
↳ fromobjectInformation about the source sender
↳ addressstringEmail address or other identifier
↳ namestringName of the sender
↳ toobjectInformation about the recipient
↳ addressstringEmail address or other identifier
↳ namestringName of the recipient
↳ relstringRelationship type
↳ created_atstringWhen the ticket was created (ISO 8601 format)
↳ updated_atstringWhen the ticket was last updated (ISO 8601 format)
↳ typestringTicket type (problem, incident, question, task)
↳ subjectstringSubject of the ticket
↳ raw_subjectstringSubject of the ticket as entered by the requester
↳ descriptionstringRead-only first comment on the ticket
↳ prioritystringPriority level (low, normal, high, urgent)
↳ statusstringTicket status (new, open, pending, hold, solved, closed)
↳ recipientstringOriginal recipient email address
↳ requester_idnumberUser ID of the ticket requester
↳ submitter_idnumberUser ID of the ticket submitter
↳ assignee_idnumberUser ID of the agent assigned to the ticket
↳ organization_idnumberOrganization ID of the requester
↳ group_idnumberGroup ID assigned to the ticket
↳ collaborator_idsarrayUser IDs of collaborators (CC)
↳ follower_idsarrayUser IDs of followers
↳ email_cc_idsarrayUser IDs of email CCs
↳ forum_topic_idnumberTopic ID in the community forum
↳ problem_idnumberFor incident tickets, the ID of the associated problem ticket
↳ has_incidentsbooleanWhether the ticket has incident tickets linked
↳ is_publicbooleanWhether the first comment is public
↳ due_atstringDue date for task tickets (ISO 8601 format)
↳ tagsarrayTags associated with the ticket
↳ custom_fieldsarrayCustom ticket fields
↳ idnumberCustom field ID
↳ valuestringCustom field value
↳ custom_status_idnumberCustom status ID
↳ satisfaction_ratingobjectCustomer satisfaction rating
↳ idnumberSatisfaction rating ID
↳ scorestringRating score (e.g., good, bad, offered, unoffered)
↳ commentstringComment left with the rating
↳ sharing_agreement_idsarraySharing agreement IDs
↳ followup_idsarrayIDs of follow-up tickets
↳ brand_idnumberBrand ID the ticket belongs to
↳ allow_attachmentsbooleanWhether attachments are allowed
↳ allow_channelbackbooleanWhether channelback is enabled
↳ from_messaging_channelbooleanWhether the ticket originated from a messaging channel
↳ ticket_form_idnumberTicket form ID
↳ generated_timestampnumberUnix timestamp of the ticket generation
pagingobjectCursor-based pagination information
↳ after_cursorstringCursor for fetching the next page of results
↳ has_morebooleanWhether more results are available
↳ next_pagestringURL for next page of results
metadataobjectResponse metadata
↳ total_returnednumberNumber of items returned in this response
↳ has_morebooleanWhether more items are available

zendesk_get_ticket

Get a single ticket by ID from Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
ticketIdstringYesTicket ID to retrieve as a numeric string (e.g., "12345")

Output

ParameterTypeDescription
ticketobjectTicket object
↳ idnumberAutomatically assigned ticket ID
↳ urlstringAPI URL of the ticket
↳ external_idstringExternal ID for linking to external records
↳ viaobjectHow the ticket was created
↳ channelstringChannel through which the ticket was created (e.g., email, web, api)
↳ sourceobjectSource details for the channel
↳ fromobjectInformation about the source sender
↳ addressstringEmail address or other identifier
↳ namestringName of the sender
↳ toobjectInformation about the recipient
↳ addressstringEmail address or other identifier
↳ namestringName of the recipient
↳ relstringRelationship type
↳ created_atstringWhen the ticket was created (ISO 8601 format)
↳ updated_atstringWhen the ticket was last updated (ISO 8601 format)
↳ typestringTicket type (problem, incident, question, task)
↳ subjectstringSubject of the ticket
↳ raw_subjectstringSubject of the ticket as entered by the requester
↳ descriptionstringRead-only first comment on the ticket
↳ prioritystringPriority level (low, normal, high, urgent)
↳ statusstringTicket status (new, open, pending, hold, solved, closed)
↳ recipientstringOriginal recipient email address
↳ requester_idnumberUser ID of the ticket requester
↳ submitter_idnumberUser ID of the ticket submitter
↳ assignee_idnumberUser ID of the agent assigned to the ticket
↳ organization_idnumberOrganization ID of the requester
↳ group_idnumberGroup ID assigned to the ticket
↳ collaborator_idsarrayUser IDs of collaborators (CC)
↳ follower_idsarrayUser IDs of followers
↳ email_cc_idsarrayUser IDs of email CCs
↳ forum_topic_idnumberTopic ID in the community forum
↳ problem_idnumberFor incident tickets, the ID of the associated problem ticket
↳ has_incidentsbooleanWhether the ticket has incident tickets linked
↳ is_publicbooleanWhether the first comment is public
↳ due_atstringDue date for task tickets (ISO 8601 format)
↳ tagsarrayTags associated with the ticket
↳ custom_fieldsarrayCustom ticket fields
↳ idnumberCustom field ID
↳ valuestringCustom field value
↳ custom_status_idnumberCustom status ID
↳ satisfaction_ratingobjectCustomer satisfaction rating
↳ idnumberSatisfaction rating ID
↳ scorestringRating score (e.g., good, bad, offered, unoffered)
↳ commentstringComment left with the rating
↳ sharing_agreement_idsarraySharing agreement IDs
↳ followup_idsarrayIDs of follow-up tickets
↳ brand_idnumberBrand ID the ticket belongs to
↳ allow_attachmentsbooleanWhether attachments are allowed
↳ allow_channelbackbooleanWhether channelback is enabled
↳ from_messaging_channelbooleanWhether the ticket originated from a messaging channel
↳ ticket_form_idnumberTicket form ID
↳ generated_timestampnumberUnix timestamp of the ticket generation
ticket_idnumberThe ticket ID

zendesk_create_ticket

Create a new ticket in Zendesk with support for custom fields

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
subjectstringNoTicket subject (optional - will be auto-generated if not provided)
descriptionstringYesTicket description text (first comment)
prioritystringNoPriority: "low", "normal", "high", or "urgent"
statusstringNoStatus: "new", "open", "pending", "hold", "solved", or "closed"
typestringNoType: "problem", "incident", "question", or "task"
tagsstringNoComma-separated tags (e.g., "billing, urgent")
assigneeIdstringNoAssignee user ID as a numeric string (e.g., "12345")
groupIdstringNoGroup ID as a numeric string (e.g., "67890")
requesterIdstringNoRequester user ID as a numeric string (e.g., "11111")
customFieldsstringNoCustom fields as JSON object (e.g., {"field_id": "value"})

Output

ParameterTypeDescription
ticketobjectCreated ticket object
↳ idnumberAutomatically assigned ticket ID
↳ urlstringAPI URL of the ticket
↳ external_idstringExternal ID for linking to external records
↳ viaobjectHow the ticket was created
↳ channelstringChannel through which the ticket was created (e.g., email, web, api)
↳ sourceobjectSource details for the channel
↳ fromobjectInformation about the source sender
↳ addressstringEmail address or other identifier
↳ namestringName of the sender
↳ toobjectInformation about the recipient
↳ addressstringEmail address or other identifier
↳ namestringName of the recipient
↳ relstringRelationship type
↳ created_atstringWhen the ticket was created (ISO 8601 format)
↳ updated_atstringWhen the ticket was last updated (ISO 8601 format)
↳ typestringTicket type (problem, incident, question, task)
↳ subjectstringSubject of the ticket
↳ raw_subjectstringSubject of the ticket as entered by the requester
↳ descriptionstringRead-only first comment on the ticket
↳ prioritystringPriority level (low, normal, high, urgent)
↳ statusstringTicket status (new, open, pending, hold, solved, closed)
↳ recipientstringOriginal recipient email address
↳ requester_idnumberUser ID of the ticket requester
↳ submitter_idnumberUser ID of the ticket submitter
↳ assignee_idnumberUser ID of the agent assigned to the ticket
↳ organization_idnumberOrganization ID of the requester
↳ group_idnumberGroup ID assigned to the ticket
↳ collaborator_idsarrayUser IDs of collaborators (CC)
↳ follower_idsarrayUser IDs of followers
↳ email_cc_idsarrayUser IDs of email CCs
↳ forum_topic_idnumberTopic ID in the community forum
↳ problem_idnumberFor incident tickets, the ID of the associated problem ticket
↳ has_incidentsbooleanWhether the ticket has incident tickets linked
↳ is_publicbooleanWhether the first comment is public
↳ due_atstringDue date for task tickets (ISO 8601 format)
↳ tagsarrayTags associated with the ticket
↳ custom_fieldsarrayCustom ticket fields
↳ idnumberCustom field ID
↳ valuestringCustom field value
↳ custom_status_idnumberCustom status ID
↳ satisfaction_ratingobjectCustomer satisfaction rating
↳ idnumberSatisfaction rating ID
↳ scorestringRating score (e.g., good, bad, offered, unoffered)
↳ commentstringComment left with the rating
↳ sharing_agreement_idsarraySharing agreement IDs
↳ followup_idsarrayIDs of follow-up tickets
↳ brand_idnumberBrand ID the ticket belongs to
↳ allow_attachmentsbooleanWhether attachments are allowed
↳ allow_channelbackbooleanWhether channelback is enabled
↳ from_messaging_channelbooleanWhether the ticket originated from a messaging channel
↳ ticket_form_idnumberTicket form ID
↳ generated_timestampnumberUnix timestamp of the ticket generation
ticket_idnumberThe created ticket ID

zendesk_create_tickets_bulk

Create multiple tickets in Zendesk at once (max 100)

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
ticketsstringYesJSON array of ticket objects to create (max 100). Each ticket should have subject and comment properties (e.g., [{"subject": "Issue 1", "comment": {"body": "Description"}}])

Output

ParameterTypeDescription
job_statusobjectJob status object for bulk operations
↳ idstringAutomatically assigned job ID
↳ urlstringURL to poll for status updates
↳ statusstringCurrent job status (queued, working, failed, completed)
↳ job_typestringCategory of background task
↳ totalnumberTotal number of tasks in this job
↳ progressnumberNumber of tasks already completed
↳ messagestringMessage from the job worker
↳ resultsarrayArray of result objects from the job
↳ idnumberID of the created or updated resource
↳ indexnumberPosition of the result in the batch
↳ actionstringAction performed (e.g., create, update)
↳ successbooleanWhether the operation succeeded
↳ statusstringStatus message (e.g., Updated, Created)
↳ errorstringError message if operation failed
job_idstringThe bulk operation job ID

zendesk_update_ticket

Update an existing ticket in Zendesk with support for custom fields

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
ticketIdstringYesTicket ID to update as a numeric string (e.g., "12345")
subjectstringNoNew ticket subject text
commentstringNoComment text to add to the ticket
prioritystringNoPriority: "low", "normal", "high", or "urgent"
statusstringNoStatus: "new", "open", "pending", "hold", "solved", or "closed"
typestringNoType: "problem", "incident", "question", or "task"
tagsstringNoComma-separated tags (e.g., "billing, urgent")
assigneeIdstringNoAssignee user ID as a numeric string (e.g., "12345")
groupIdstringNoGroup ID as a numeric string (e.g., "67890")
customFieldsstringNoCustom fields as JSON object (e.g., {"field_id": "value"})

Output

ParameterTypeDescription
ticketobjectUpdated ticket object
↳ idnumberAutomatically assigned ticket ID
↳ urlstringAPI URL of the ticket
↳ external_idstringExternal ID for linking to external records
↳ viaobjectHow the ticket was created
↳ channelstringChannel through which the ticket was created (e.g., email, web, api)
↳ sourceobjectSource details for the channel
↳ fromobjectInformation about the source sender
↳ addressstringEmail address or other identifier
↳ namestringName of the sender
↳ toobjectInformation about the recipient
↳ addressstringEmail address or other identifier
↳ namestringName of the recipient
↳ relstringRelationship type
↳ created_atstringWhen the ticket was created (ISO 8601 format)
↳ updated_atstringWhen the ticket was last updated (ISO 8601 format)
↳ typestringTicket type (problem, incident, question, task)
↳ subjectstringSubject of the ticket
↳ raw_subjectstringSubject of the ticket as entered by the requester
↳ descriptionstringRead-only first comment on the ticket
↳ prioritystringPriority level (low, normal, high, urgent)
↳ statusstringTicket status (new, open, pending, hold, solved, closed)
↳ recipientstringOriginal recipient email address
↳ requester_idnumberUser ID of the ticket requester
↳ submitter_idnumberUser ID of the ticket submitter
↳ assignee_idnumberUser ID of the agent assigned to the ticket
↳ organization_idnumberOrganization ID of the requester
↳ group_idnumberGroup ID assigned to the ticket
↳ collaborator_idsarrayUser IDs of collaborators (CC)
↳ follower_idsarrayUser IDs of followers
↳ email_cc_idsarrayUser IDs of email CCs
↳ forum_topic_idnumberTopic ID in the community forum
↳ problem_idnumberFor incident tickets, the ID of the associated problem ticket
↳ has_incidentsbooleanWhether the ticket has incident tickets linked
↳ is_publicbooleanWhether the first comment is public
↳ due_atstringDue date for task tickets (ISO 8601 format)
↳ tagsarrayTags associated with the ticket
↳ custom_fieldsarrayCustom ticket fields
↳ idnumberCustom field ID
↳ valuestringCustom field value
↳ custom_status_idnumberCustom status ID
↳ satisfaction_ratingobjectCustomer satisfaction rating
↳ idnumberSatisfaction rating ID
↳ scorestringRating score (e.g., good, bad, offered, unoffered)
↳ commentstringComment left with the rating
↳ sharing_agreement_idsarraySharing agreement IDs
↳ followup_idsarrayIDs of follow-up tickets
↳ brand_idnumberBrand ID the ticket belongs to
↳ allow_attachmentsbooleanWhether attachments are allowed
↳ allow_channelbackbooleanWhether channelback is enabled
↳ from_messaging_channelbooleanWhether the ticket originated from a messaging channel
↳ ticket_form_idnumberTicket form ID
↳ generated_timestampnumberUnix timestamp of the ticket generation
ticket_idnumberThe updated ticket ID

zendesk_update_tickets_bulk

Update multiple tickets in Zendesk at once (max 100)

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
ticketIdsstringYesComma-separated ticket IDs to update (max 100, e.g., "111, 222, 333")
statusstringNoNew status for all tickets: "new", "open", "pending", "hold", "solved", or "closed"
prioritystringNoNew priority for all tickets: "low", "normal", "high", or "urgent"
assigneeIdstringNoNew assignee ID for all tickets as a numeric string (e.g., "12345")
groupIdstringNoNew group ID for all tickets as a numeric string (e.g., "67890")
tagsstringNoComma-separated tags to add to all tickets (e.g., "bulk-update, processed")

Output

ParameterTypeDescription
job_statusobjectJob status object for bulk operations
↳ idstringAutomatically assigned job ID
↳ urlstringURL to poll for status updates
↳ statusstringCurrent job status (queued, working, failed, completed)
↳ job_typestringCategory of background task
↳ totalnumberTotal number of tasks in this job
↳ progressnumberNumber of tasks already completed
↳ messagestringMessage from the job worker
↳ resultsarrayArray of result objects from the job
↳ idnumberID of the created or updated resource
↳ indexnumberPosition of the result in the batch
↳ actionstringAction performed (e.g., create, update)
↳ successbooleanWhether the operation succeeded
↳ statusstringStatus message (e.g., Updated, Created)
↳ errorstringError message if operation failed
job_idstringThe bulk operation job ID

zendesk_delete_ticket

Delete a ticket from Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
ticketIdstringYesTicket ID to delete as a numeric string (e.g., "12345")

Output

ParameterTypeDescription
deletedbooleanDeletion success
ticket_idstringThe deleted ticket ID

zendesk_merge_tickets

Merge multiple tickets into a target ticket

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
targetTicketIdstringYesTarget ticket ID as a numeric string (tickets will be merged into this one, e.g., "12345")
sourceTicketIdsstringYesComma-separated source ticket IDs to merge (e.g., "111, 222, 333")
targetCommentstringNoComment text to add to target ticket after merge

Output

ParameterTypeDescription
job_statusobjectJob status object for bulk operations
↳ idstringAutomatically assigned job ID
↳ urlstringURL to poll for status updates
↳ statusstringCurrent job status (queued, working, failed, completed)
↳ job_typestringCategory of background task
↳ totalnumberTotal number of tasks in this job
↳ progressnumberNumber of tasks already completed
↳ messagestringMessage from the job worker
↳ resultsarrayArray of result objects from the job
↳ idnumberID of the created or updated resource
↳ indexnumberPosition of the result in the batch
↳ actionstringAction performed (e.g., create, update)
↳ successbooleanWhether the operation succeeded
↳ statusstringStatus message (e.g., Updated, Created)
↳ errorstringError message if operation failed
job_idstringThe merge job ID
target_ticket_idstringThe target ticket ID that tickets were merged into

zendesk_get_users

Retrieve a list of users from Zendesk with optional filtering

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain (e.g., "mycompany" for mycompany.zendesk.com)
rolestringNoFilter by role: "end-user", "agent", or "admin"
permissionSetstringNoFilter by permission set ID as a numeric string (e.g., "12345")
perPagestringNoResults per page as a number string (default: "100", max: "100")
pageAfterstringNoCursor from a previous response to fetch the next page of results

Output

ParameterTypeDescription
usersarrayArray of user objects
↳ idnumberAutomatically assigned user ID
↳ urlstringAPI URL of the user
↳ namestringUser name
↳ emailstringPrimary email address
↳ created_atstringWhen the user was created (ISO 8601 format)
↳ updated_atstringWhen the user was last updated (ISO 8601 format)
↳ time_zonestringTime zone (e.g., Eastern Time (US & Canada))
↳ iana_time_zonestringIANA time zone (e.g., America/New_York)
↳ phonestringPhone number
↳ shared_phone_numberbooleanWhether the phone number is shared
↳ photoobjectUser photo details
↳ content_urlstringURL to the photo
↳ file_namestringPhoto file name
↳ sizenumberFile size in bytes
↳ localestringLocale (e.g., en-US)
↳ locale_idnumberLocale ID
↳ organization_idnumberPrimary organization ID
↳ rolestringUser role (end-user, agent, admin)
↳ role_typenumberRole type identifier
↳ custom_role_idnumberCustom role ID
↳ activebooleanWhether the user is active (false if deleted)
↳ verifiedbooleanWhether any user identity has been verified
↳ aliasstringAlias displayed to end users
↳ detailsstringDetails about the user
↳ notesstringNotes about the user
↳ signaturestringUser signature for email replies
↳ default_group_idnumberDefault group ID for the user
↳ tagsarrayTags associated with the user
↳ external_idstringExternal ID for linking to external records
↳ restricted_agentbooleanWhether the agent has restrictions
↳ suspendedbooleanWhether the user is suspended
↳ moderatorbooleanWhether the user has moderator permissions
↳ chat_onlybooleanWhether the user is a chat-only agent
↳ only_private_commentsbooleanWhether the user can only create private comments
↳ two_factor_auth_enabledbooleanWhether two-factor auth is enabled
↳ last_login_atstringLast login time (ISO 8601 format)
↳ ticket_restrictionstringTicket access restriction (organization, groups, assigned, requested)
↳ user_fieldsjsonCustom user fields (dynamic key-value pairs)
↳ sharedbooleanWhether the user is shared from a different Zendesk
↳ shared_agentbooleanWhether the agent is shared from a different Zendesk
↳ remote_photo_urlstringURL to a remote photo
pagingobjectCursor-based pagination information
↳ after_cursorstringCursor for fetching the next page of results
↳ has_morebooleanWhether more results are available
↳ next_pagestringURL for next page of results
metadataobjectResponse metadata
↳ total_returnednumberNumber of items returned in this response
↳ has_morebooleanWhether more items are available

zendesk_get_user

Get a single user by ID from Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
userIdstringYesUser ID to retrieve as a numeric string (e.g., "12345")

Output

ParameterTypeDescription
userobjectUser object
↳ idnumberAutomatically assigned user ID
↳ urlstringAPI URL of the user
↳ namestringUser name
↳ emailstringPrimary email address
↳ created_atstringWhen the user was created (ISO 8601 format)
↳ updated_atstringWhen the user was last updated (ISO 8601 format)
↳ time_zonestringTime zone (e.g., Eastern Time (US & Canada))
↳ iana_time_zonestringIANA time zone (e.g., America/New_York)
↳ phonestringPhone number
↳ shared_phone_numberbooleanWhether the phone number is shared
↳ photoobjectUser photo details
↳ content_urlstringURL to the photo
↳ file_namestringPhoto file name
↳ sizenumberFile size in bytes
↳ localestringLocale (e.g., en-US)
↳ locale_idnumberLocale ID
↳ organization_idnumberPrimary organization ID
↳ rolestringUser role (end-user, agent, admin)
↳ role_typenumberRole type identifier
↳ custom_role_idnumberCustom role ID
↳ activebooleanWhether the user is active (false if deleted)
↳ verifiedbooleanWhether any user identity has been verified
↳ aliasstringAlias displayed to end users
↳ detailsstringDetails about the user
↳ notesstringNotes about the user
↳ signaturestringUser signature for email replies
↳ default_group_idnumberDefault group ID for the user
↳ tagsarrayTags associated with the user
↳ external_idstringExternal ID for linking to external records
↳ restricted_agentbooleanWhether the agent has restrictions
↳ suspendedbooleanWhether the user is suspended
↳ moderatorbooleanWhether the user has moderator permissions
↳ chat_onlybooleanWhether the user is a chat-only agent
↳ only_private_commentsbooleanWhether the user can only create private comments
↳ two_factor_auth_enabledbooleanWhether two-factor auth is enabled
↳ last_login_atstringLast login time (ISO 8601 format)
↳ ticket_restrictionstringTicket access restriction (organization, groups, assigned, requested)
↳ user_fieldsjsonCustom user fields (dynamic key-value pairs)
↳ sharedbooleanWhether the user is shared from a different Zendesk
↳ shared_agentbooleanWhether the agent is shared from a different Zendesk
↳ remote_photo_urlstringURL to a remote photo
user_idnumberThe user ID

zendesk_get_current_user

Get the currently authenticated user from Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain

Output

ParameterTypeDescription
userobjectCurrent user object
↳ idnumberAutomatically assigned user ID
↳ urlstringAPI URL of the user
↳ namestringUser name
↳ emailstringPrimary email address
↳ created_atstringWhen the user was created (ISO 8601 format)
↳ updated_atstringWhen the user was last updated (ISO 8601 format)
↳ time_zonestringTime zone (e.g., Eastern Time (US & Canada))
↳ iana_time_zonestringIANA time zone (e.g., America/New_York)
↳ phonestringPhone number
↳ shared_phone_numberbooleanWhether the phone number is shared
↳ photoobjectUser photo details
↳ content_urlstringURL to the photo
↳ file_namestringPhoto file name
↳ sizenumberFile size in bytes
↳ localestringLocale (e.g., en-US)
↳ locale_idnumberLocale ID
↳ organization_idnumberPrimary organization ID
↳ rolestringUser role (end-user, agent, admin)
↳ role_typenumberRole type identifier
↳ custom_role_idnumberCustom role ID
↳ activebooleanWhether the user is active (false if deleted)
↳ verifiedbooleanWhether any user identity has been verified
↳ aliasstringAlias displayed to end users
↳ detailsstringDetails about the user
↳ notesstringNotes about the user
↳ signaturestringUser signature for email replies
↳ default_group_idnumberDefault group ID for the user
↳ tagsarrayTags associated with the user
↳ external_idstringExternal ID for linking to external records
↳ restricted_agentbooleanWhether the agent has restrictions
↳ suspendedbooleanWhether the user is suspended
↳ moderatorbooleanWhether the user has moderator permissions
↳ chat_onlybooleanWhether the user is a chat-only agent
↳ only_private_commentsbooleanWhether the user can only create private comments
↳ two_factor_auth_enabledbooleanWhether two-factor auth is enabled
↳ last_login_atstringLast login time (ISO 8601 format)
↳ ticket_restrictionstringTicket access restriction (organization, groups, assigned, requested)
↳ user_fieldsjsonCustom user fields (dynamic key-value pairs)
↳ sharedbooleanWhether the user is shared from a different Zendesk
↳ shared_agentbooleanWhether the agent is shared from a different Zendesk
↳ remote_photo_urlstringURL to a remote photo
user_idnumberThe current user ID

zendesk_search_users

Search for users in Zendesk using a query string

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
querystringNoSearch query string (e.g., user name or email)
externalIdstringNoExternal ID to search by (your system identifier)
perPagestringNoResults per page as a number string (default: "100", max: "100")
pagestringNoPage number for pagination (1-based)

Output

ParameterTypeDescription
usersarrayArray of user objects
↳ idnumberAutomatically assigned user ID
↳ urlstringAPI URL of the user
↳ namestringUser name
↳ emailstringPrimary email address
↳ created_atstringWhen the user was created (ISO 8601 format)
↳ updated_atstringWhen the user was last updated (ISO 8601 format)
↳ time_zonestringTime zone (e.g., Eastern Time (US & Canada))
↳ iana_time_zonestringIANA time zone (e.g., America/New_York)
↳ phonestringPhone number
↳ shared_phone_numberbooleanWhether the phone number is shared
↳ photoobjectUser photo details
↳ content_urlstringURL to the photo
↳ file_namestringPhoto file name
↳ sizenumberFile size in bytes
↳ localestringLocale (e.g., en-US)
↳ locale_idnumberLocale ID
↳ organization_idnumberPrimary organization ID
↳ rolestringUser role (end-user, agent, admin)
↳ role_typenumberRole type identifier
↳ custom_role_idnumberCustom role ID
↳ activebooleanWhether the user is active (false if deleted)
↳ verifiedbooleanWhether any user identity has been verified
↳ aliasstringAlias displayed to end users
↳ detailsstringDetails about the user
↳ notesstringNotes about the user
↳ signaturestringUser signature for email replies
↳ default_group_idnumberDefault group ID for the user
↳ tagsarrayTags associated with the user
↳ external_idstringExternal ID for linking to external records
↳ restricted_agentbooleanWhether the agent has restrictions
↳ suspendedbooleanWhether the user is suspended
↳ moderatorbooleanWhether the user has moderator permissions
↳ chat_onlybooleanWhether the user is a chat-only agent
↳ only_private_commentsbooleanWhether the user can only create private comments
↳ two_factor_auth_enabledbooleanWhether two-factor auth is enabled
↳ last_login_atstringLast login time (ISO 8601 format)
↳ ticket_restrictionstringTicket access restriction (organization, groups, assigned, requested)
↳ user_fieldsjsonCustom user fields (dynamic key-value pairs)
↳ sharedbooleanWhether the user is shared from a different Zendesk
↳ shared_agentbooleanWhether the agent is shared from a different Zendesk
↳ remote_photo_urlstringURL to a remote photo
pagingobjectCursor-based pagination information
↳ after_cursorstringCursor for fetching the next page of results
↳ has_morebooleanWhether more results are available
↳ next_pagestringURL for next page of results
metadataobjectResponse metadata
↳ total_returnednumberNumber of items returned in this response
↳ has_morebooleanWhether more items are available

zendesk_create_user

Create a new user in Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
namestringYesUser full name (e.g., "John Smith")
userEmailstringNoUser email address (e.g., "john@example.com")
rolestringNoUser role: "end-user", "agent", or "admin"
phonestringNoUser phone number (e.g., "+1-555-123-4567")
organizationIdstringNoOrganization ID as a numeric string (e.g., "12345")
verifiedstringNoSet to "true" to skip email verification, or "false" otherwise
tagsstringNoComma-separated tags (e.g., "vip, enterprise")
customFieldsstringNoCustom fields as JSON object (e.g., {"field_id": "value"})

Output

ParameterTypeDescription
userobjectCreated user object
↳ idnumberAutomatically assigned user ID
↳ urlstringAPI URL of the user
↳ namestringUser name
↳ emailstringPrimary email address
↳ created_atstringWhen the user was created (ISO 8601 format)
↳ updated_atstringWhen the user was last updated (ISO 8601 format)
↳ time_zonestringTime zone (e.g., Eastern Time (US & Canada))
↳ iana_time_zonestringIANA time zone (e.g., America/New_York)
↳ phonestringPhone number
↳ shared_phone_numberbooleanWhether the phone number is shared
↳ photoobjectUser photo details
↳ content_urlstringURL to the photo
↳ file_namestringPhoto file name
↳ sizenumberFile size in bytes
↳ localestringLocale (e.g., en-US)
↳ locale_idnumberLocale ID
↳ organization_idnumberPrimary organization ID
↳ rolestringUser role (end-user, agent, admin)
↳ role_typenumberRole type identifier
↳ custom_role_idnumberCustom role ID
↳ activebooleanWhether the user is active (false if deleted)
↳ verifiedbooleanWhether any user identity has been verified
↳ aliasstringAlias displayed to end users
↳ detailsstringDetails about the user
↳ notesstringNotes about the user
↳ signaturestringUser signature for email replies
↳ default_group_idnumberDefault group ID for the user
↳ tagsarrayTags associated with the user
↳ external_idstringExternal ID for linking to external records
↳ restricted_agentbooleanWhether the agent has restrictions
↳ suspendedbooleanWhether the user is suspended
↳ moderatorbooleanWhether the user has moderator permissions
↳ chat_onlybooleanWhether the user is a chat-only agent
↳ only_private_commentsbooleanWhether the user can only create private comments
↳ two_factor_auth_enabledbooleanWhether two-factor auth is enabled
↳ last_login_atstringLast login time (ISO 8601 format)
↳ ticket_restrictionstringTicket access restriction (organization, groups, assigned, requested)
↳ user_fieldsjsonCustom user fields (dynamic key-value pairs)
↳ sharedbooleanWhether the user is shared from a different Zendesk
↳ shared_agentbooleanWhether the agent is shared from a different Zendesk
↳ remote_photo_urlstringURL to a remote photo
user_idnumberThe created user ID

zendesk_create_users_bulk

Create multiple users in Zendesk using bulk import

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
usersstringYesJSON array of user objects to create (e.g., [{"name": "User1", "email": "user1@example.com"}])

Output

ParameterTypeDescription
job_statusobjectJob status object for bulk operations
↳ idstringAutomatically assigned job ID
↳ urlstringURL to poll for status updates
↳ statusstringCurrent job status (queued, working, failed, completed)
↳ job_typestringCategory of background task
↳ totalnumberTotal number of tasks in this job
↳ progressnumberNumber of tasks already completed
↳ messagestringMessage from the job worker
↳ resultsarrayArray of result objects from the job
↳ idnumberID of the created or updated resource
↳ indexnumberPosition of the result in the batch
↳ actionstringAction performed (e.g., create, update)
↳ successbooleanWhether the operation succeeded
↳ statusstringStatus message (e.g., Updated, Created)
↳ errorstringError message if operation failed
job_idstringThe bulk operation job ID

zendesk_update_user

Update an existing user in Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
userIdstringYesUser ID to update as a numeric string (e.g., "12345")
namestringNoNew user full name (e.g., "John Smith")
userEmailstringNoNew user email address (e.g., "john@example.com")
rolestringNoUser role: "end-user", "agent", or "admin"
phonestringNoUser phone number (e.g., "+1-555-123-4567")
organizationIdstringNoOrganization ID as a numeric string (e.g., "67890")
verifiedstringNoSet to "true" to mark user as verified, or "false" otherwise
tagsstringNoComma-separated tags (e.g., "vip, enterprise")
customFieldsstringNoCustom fields as JSON object (e.g., {"field_id": "value"})

Output

ParameterTypeDescription
userobjectUpdated user object
↳ idnumberAutomatically assigned user ID
↳ urlstringAPI URL of the user
↳ namestringUser name
↳ emailstringPrimary email address
↳ created_atstringWhen the user was created (ISO 8601 format)
↳ updated_atstringWhen the user was last updated (ISO 8601 format)
↳ time_zonestringTime zone (e.g., Eastern Time (US & Canada))
↳ iana_time_zonestringIANA time zone (e.g., America/New_York)
↳ phonestringPhone number
↳ shared_phone_numberbooleanWhether the phone number is shared
↳ photoobjectUser photo details
↳ content_urlstringURL to the photo
↳ file_namestringPhoto file name
↳ sizenumberFile size in bytes
↳ localestringLocale (e.g., en-US)
↳ locale_idnumberLocale ID
↳ organization_idnumberPrimary organization ID
↳ rolestringUser role (end-user, agent, admin)
↳ role_typenumberRole type identifier
↳ custom_role_idnumberCustom role ID
↳ activebooleanWhether the user is active (false if deleted)
↳ verifiedbooleanWhether any user identity has been verified
↳ aliasstringAlias displayed to end users
↳ detailsstringDetails about the user
↳ notesstringNotes about the user
↳ signaturestringUser signature for email replies
↳ default_group_idnumberDefault group ID for the user
↳ tagsarrayTags associated with the user
↳ external_idstringExternal ID for linking to external records
↳ restricted_agentbooleanWhether the agent has restrictions
↳ suspendedbooleanWhether the user is suspended
↳ moderatorbooleanWhether the user has moderator permissions
↳ chat_onlybooleanWhether the user is a chat-only agent
↳ only_private_commentsbooleanWhether the user can only create private comments
↳ two_factor_auth_enabledbooleanWhether two-factor auth is enabled
↳ last_login_atstringLast login time (ISO 8601 format)
↳ ticket_restrictionstringTicket access restriction (organization, groups, assigned, requested)
↳ user_fieldsjsonCustom user fields (dynamic key-value pairs)
↳ sharedbooleanWhether the user is shared from a different Zendesk
↳ shared_agentbooleanWhether the agent is shared from a different Zendesk
↳ remote_photo_urlstringURL to a remote photo
user_idnumberThe updated user ID

zendesk_update_users_bulk

Update multiple users in Zendesk using bulk update

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
usersstringYesJSON array of user objects to update, each must include id field (e.g., [{"id": "123", "name": "New Name"}])

Output

ParameterTypeDescription
job_statusobjectJob status object for bulk operations
↳ idstringAutomatically assigned job ID
↳ urlstringURL to poll for status updates
↳ statusstringCurrent job status (queued, working, failed, completed)
↳ job_typestringCategory of background task
↳ totalnumberTotal number of tasks in this job
↳ progressnumberNumber of tasks already completed
↳ messagestringMessage from the job worker
↳ resultsarrayArray of result objects from the job
↳ idnumberID of the created or updated resource
↳ indexnumberPosition of the result in the batch
↳ actionstringAction performed (e.g., create, update)
↳ successbooleanWhether the operation succeeded
↳ statusstringStatus message (e.g., Updated, Created)
↳ errorstringError message if operation failed
job_idstringThe bulk operation job ID

zendesk_delete_user

Delete a user from Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
userIdstringYesUser ID to delete as a numeric string (e.g., "12345")

Output

ParameterTypeDescription
deletedbooleanDeletion success
user_idstringThe deleted user ID

zendesk_get_organizations

Retrieve a list of organizations from Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain (e.g., "mycompany" for mycompany.zendesk.com)
perPagestringNoResults per page as a number string (default: "100", max: "100")
pageAfterstringNoCursor from a previous response to fetch the next page of results

Output

ParameterTypeDescription
organizationsarrayArray of organization objects
↳ idnumberAutomatically assigned organization ID
↳ urlstringAPI URL of the organization
↳ namestringUnique organization name
↳ domain_namesarrayDomain names for automatic user assignment
↳ detailsstringDetails about the organization
↳ notesstringNotes about the organization
↳ group_idnumberGroup ID for auto-routing new tickets
↳ shared_ticketsbooleanWhether end users can see each others tickets
↳ shared_commentsbooleanWhether end users can see each others comments
↳ tagsarrayTags associated with the organization
↳ organization_fieldsjsonCustom organization fields (dynamic key-value pairs)
↳ created_atstringWhen the organization was created (ISO 8601 format)
↳ updated_atstringWhen the organization was last updated (ISO 8601 format)
↳ external_idstringExternal ID for linking to external records
pagingobjectCursor-based pagination information
↳ after_cursorstringCursor for fetching the next page of results
↳ has_morebooleanWhether more results are available
↳ next_pagestringURL for next page of results
metadataobjectResponse metadata
↳ total_returnednumberNumber of items returned in this response
↳ has_morebooleanWhether more items are available

zendesk_get_organization

Get a single organization by ID from Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
organizationIdstringYesOrganization ID to retrieve as a numeric string (e.g., "12345")

Output

ParameterTypeDescription
organizationobjectOrganization object
↳ idnumberAutomatically assigned organization ID
↳ urlstringAPI URL of the organization
↳ namestringUnique organization name
↳ domain_namesarrayDomain names for automatic user assignment
↳ detailsstringDetails about the organization
↳ notesstringNotes about the organization
↳ group_idnumberGroup ID for auto-routing new tickets
↳ shared_ticketsbooleanWhether end users can see each others tickets
↳ shared_commentsbooleanWhether end users can see each others comments
↳ tagsarrayTags associated with the organization
↳ organization_fieldsjsonCustom organization fields (dynamic key-value pairs)
↳ created_atstringWhen the organization was created (ISO 8601 format)
↳ updated_atstringWhen the organization was last updated (ISO 8601 format)
↳ external_idstringExternal ID for linking to external records
organization_idnumberThe organization ID

zendesk_autocomplete_organizations

Autocomplete organizations in Zendesk by name prefix (for name matching/autocomplete)

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
namestringYesOrganization name prefix to search for (e.g., "Acme")
perPagestringNoResults per page as a number string (default: "100", max: "100")
pagestringNoPage number for pagination (1-based)

Output

ParameterTypeDescription
organizationsarrayArray of organization objects
↳ idnumberAutomatically assigned organization ID
↳ urlstringAPI URL of the organization
↳ namestringUnique organization name
↳ domain_namesarrayDomain names for automatic user assignment
↳ detailsstringDetails about the organization
↳ notesstringNotes about the organization
↳ group_idnumberGroup ID for auto-routing new tickets
↳ shared_ticketsbooleanWhether end users can see each others tickets
↳ shared_commentsbooleanWhether end users can see each others comments
↳ tagsarrayTags associated with the organization
↳ organization_fieldsjsonCustom organization fields (dynamic key-value pairs)
↳ created_atstringWhen the organization was created (ISO 8601 format)
↳ updated_atstringWhen the organization was last updated (ISO 8601 format)
↳ external_idstringExternal ID for linking to external records
pagingobjectCursor-based pagination information
↳ after_cursorstringCursor for fetching the next page of results
↳ has_morebooleanWhether more results are available
↳ next_pagestringURL for next page of results
metadataobjectResponse metadata
↳ total_returnednumberNumber of items returned in this response
↳ has_morebooleanWhether more items are available

zendesk_create_organization

Create a new organization in Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
namestringYesOrganization name (e.g., "Acme Corporation")
domainNamesstringNoComma-separated domain names (e.g., "acme.com, acme.org")
detailsstringNoOrganization details text
notesstringNoOrganization notes text
tagsstringNoComma-separated tags (e.g., "enterprise, priority")
customFieldsstringNoCustom fields as JSON object (e.g., {"field_id": "value"})

Output

ParameterTypeDescription
organizationobjectCreated organization object
↳ idnumberAutomatically assigned organization ID
↳ urlstringAPI URL of the organization
↳ namestringUnique organization name
↳ domain_namesarrayDomain names for automatic user assignment
↳ detailsstringDetails about the organization
↳ notesstringNotes about the organization
↳ group_idnumberGroup ID for auto-routing new tickets
↳ shared_ticketsbooleanWhether end users can see each others tickets
↳ shared_commentsbooleanWhether end users can see each others comments
↳ tagsarrayTags associated with the organization
↳ organization_fieldsjsonCustom organization fields (dynamic key-value pairs)
↳ created_atstringWhen the organization was created (ISO 8601 format)
↳ updated_atstringWhen the organization was last updated (ISO 8601 format)
↳ external_idstringExternal ID for linking to external records
organization_idnumberThe created organization ID

zendesk_create_organizations_bulk

Create multiple organizations in Zendesk using bulk import

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
organizationsstringYesJSON array of organization objects to create (e.g., [{"name": "Org1"}, {"name": "Org2"}])

Output

ParameterTypeDescription
job_statusobjectJob status object for bulk operations
↳ idstringAutomatically assigned job ID
↳ urlstringURL to poll for status updates
↳ statusstringCurrent job status (queued, working, failed, completed)
↳ job_typestringCategory of background task
↳ totalnumberTotal number of tasks in this job
↳ progressnumberNumber of tasks already completed
↳ messagestringMessage from the job worker
↳ resultsarrayArray of result objects from the job
↳ idnumberID of the created or updated resource
↳ indexnumberPosition of the result in the batch
↳ actionstringAction performed (e.g., create, update)
↳ successbooleanWhether the operation succeeded
↳ statusstringStatus message (e.g., Updated, Created)
↳ errorstringError message if operation failed
job_idstringThe bulk operation job ID

zendesk_update_organization

Update an existing organization in Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
organizationIdstringYesOrganization ID to update as a numeric string (e.g., "12345")
namestringNoNew organization name (e.g., "Acme Corporation")
domainNamesstringNoComma-separated domain names (e.g., "acme.com, acme.org")
detailsstringNoOrganization details text
notesstringNoOrganization notes text
tagsstringNoComma-separated tags (e.g., "enterprise, priority")
customFieldsstringNoCustom fields as JSON object (e.g., {"field_id": "value"})

Output

ParameterTypeDescription
organizationobjectUpdated organization object
↳ idnumberAutomatically assigned organization ID
↳ urlstringAPI URL of the organization
↳ namestringUnique organization name
↳ domain_namesarrayDomain names for automatic user assignment
↳ detailsstringDetails about the organization
↳ notesstringNotes about the organization
↳ group_idnumberGroup ID for auto-routing new tickets
↳ shared_ticketsbooleanWhether end users can see each others tickets
↳ shared_commentsbooleanWhether end users can see each others comments
↳ tagsarrayTags associated with the organization
↳ organization_fieldsjsonCustom organization fields (dynamic key-value pairs)
↳ created_atstringWhen the organization was created (ISO 8601 format)
↳ updated_atstringWhen the organization was last updated (ISO 8601 format)
↳ external_idstringExternal ID for linking to external records
organization_idnumberThe updated organization ID

zendesk_delete_organization

Delete an organization from Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
organizationIdstringYesOrganization ID to delete as a numeric string (e.g., "12345")

Output

ParameterTypeDescription
deletedbooleanWhether the organization was successfully deleted
organization_idstringThe deleted organization ID

Unified search across tickets, users, and organizations in Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
querystringYesSearch query string using Zendesk search syntax (e.g., "type:ticket status:open")
filterTypestringYesResource type to search for: "ticket", "user", "organization", or "group"
perPagestringNoResults per page as a number string (default: "100", max: "100")
pageAfterstringNoCursor from a previous response to fetch the next page of results

Output

ParameterTypeDescription
pagingobjectCursor-based pagination information
↳ after_cursorstringCursor for fetching the next page of results
↳ has_morebooleanWhether more results are available
↳ next_pagestringURL for next page of results
metadataobjectResponse metadata
↳ total_returnednumberNumber of items returned in this response
↳ has_morebooleanWhether more items are available
resultsarrayArray of result objects (tickets, users, or organizations depending on search query)

zendesk_search_count

Count the number of search results matching a query in Zendesk

Input

ParameterTypeRequiredDescription
emailstringYesYour Zendesk email address
apiTokenstringYesZendesk API token
subdomainstringYesYour Zendesk subdomain
querystringYesSearch query string using Zendesk search syntax (e.g., "type:ticket status:open")

Output

ParameterTypeDescription
countnumberNumber of matching results

On this page