Skip to content
Talk to an Engineer Dashboard

Zendesk

Connect to Zendesk. Manage customer support tickets, users, organizations, and help desk operations

Connect to Zendesk. Manage customer support tickets, users, organizations, and help desk operations

Zendesk logo

Supports authentication: API Key

Register your Zendesk API credentials with Scalekit so it can authenticate requests on your behalf. You’ll need your Zendesk subdomain, email address, and an API token from your Zendesk Admin Center.

  1. Generate an API token

    • In your Zendesk Admin Center, go to Apps and integrations → APIs → Zendesk API.

    • Under Settings, enable Token access.

      Zendesk API configuration page with Allow API token access enabled
    • Click Add API token, enter a description, and click Create.

    • Copy the token — it is only shown once.

  2. Create a connection

    In Scalekit dashboard, go to Agent Auth → Create Connection. Find Zendesk and click Create.

  3. Create a connected account

    Go to Connected Accounts for your Zendesk connection and click Add account. Fill in the required fields:

    • Your User’s ID — a unique identifier for the user in your system

    • Zendesk Domain — your full Zendesk domain (e.g., yourcompany.zendesk.com)

    • Email Address — the Zendesk account email address

    • API Token — the token you copied in step 1

    • Click Save.

      Add connected account form for Zendesk in Scalekit dashboard

Create a new support ticket in Zendesk. Requires a comment/description and optionally a subject, priority, assignee, and tags.

NameTypeRequiredDescription
comment_bodystringYesThe description or first comment of the ticket
subjectstringNoThe subject/title of the ticket
statusstringNoTicket status: new, open, pending, hold, solved, or closed
prioritystringNoTicket priority: urgent, high, normal, or low
typestringNoTicket type: problem, incident, question, or task
assignee_emailstringNoEmail of the agent to assign the ticket to
tagsarray<string>NoList of tags to apply to the ticket

Update an existing Zendesk ticket. Change status, priority, assignee, subject, tags, or any other writable ticket field.

NameTypeRequiredDescription
ticket_idnumberYesThe ID of the ticket to update
statusstringNoTicket status: new, open, pending, hold, solved, or closed
prioritystringNoTicket priority: urgent, high, normal, or low
subjectstringNoNew subject/title for the ticket
typestringNoTicket type: problem, incident, question, or task
assignee_emailstringNoEmail of the agent to assign the ticket to
assignee_idnumberNoID of the agent to assign the ticket to
group_idnumberNoID of the group to assign the ticket to
tagsarray<string>NoList of tags to set on the ticket (replaces existing tags)

Add a public reply or internal note to a Zendesk ticket. Set public to false for internal notes visible only to agents.

NameTypeRequiredDescription
ticket_idnumberYesThe ID of the ticket to reply to
bodystringYesThe reply message content (plain text, markdown supported)
publicbooleanNotrue for a public reply, false for an internal note (default: true)

Retrieve details of a specific Zendesk ticket by ID. Returns ticket properties including status, priority, subject, requester, assignee, and timestamps.

NameTypeRequiredDescription
ticket_idnumberYesThe ID of the ticket to retrieve
includestringNoComma-separated list of sideloads to include (e.g., users, groups, organizations)

List tickets in Zendesk with sorting and pagination. Returns tickets for the authenticated agent’s account.

NameTypeRequiredDescription
pagenumberNoPage number for pagination
per_pagenumberNoNumber of tickets per page (max 100)
sort_bystringNoField to sort by: created_at, updated_at, priority, status, ticket_type
sort_orderstringNoSort direction: asc or desc (default: desc)

Search Zendesk tickets using a query string. Supports Zendesk’s search syntax (e.g., type:ticket status:open). Returns up to 1000 results with pagination.

NameTypeRequiredDescription
querystringYesSearch query string using Zendesk search syntax (e.g., type:ticket status:open assignee:me)
pagenumberNoPage number for pagination
per_pagenumberNoNumber of results per page (max 100)
sort_bystringNoField to sort results by (updated_at, created_at, priority, status, ticket_type)
sort_orderstringNoSort direction: asc or desc (default: desc)

Retrieve all comments (public replies and internal notes) for a specific Zendesk ticket. Returns comment body, author, timestamps, and attachments.

NameTypeRequiredDescription
ticket_idnumberYesThe ID of the ticket whose comments to list
includestringNoSideloads to include. Use users to include user details for email CCs
include_inline_imagesbooleanNoWhen true, inline images are listed as attachments (default: false)
sort_orderstringNoSort direction for comments: asc or desc (default: asc)

Create a new user in Zendesk. Can create end-users (customers), agents, or admins. Email is required for end-users.

NameTypeRequiredDescription
namestringYesFull name of the user
emailstringNoPrimary email address of the user
rolestringNoUser role: end-user, agent, or admin (default: end-user)
organization_idnumberNoID of the organization to associate the user with
phonestringNoPrimary phone number in E.164 format (e.g., +15551234567)
verifiedbooleanNoWhether the user’s identity is verified (default: false)

Retrieve details of a specific Zendesk user by ID. Returns user profile including name, email, role, organization, and account status.

NameTypeRequiredDescription
user_idnumberYesThe ID of the user to retrieve
includestringNoComma-separated list of sideloads to include

List users in Zendesk. Filter by role (end-user, agent, admin) with pagination support.

NameTypeRequiredDescription
pagenumberNoPage number for pagination
per_pagenumberNoNumber of users per page (max 100)
rolestringNoFilter by role: end-user, agent, or admin
sortstringNoField to sort by; prefix with - for descending (e.g., -created_at)

Retrieve details of a specific Zendesk organization by ID. Returns organization name, domain names, tags, notes, shared ticket settings, and custom fields.

NameTypeRequiredDescription
organization_idnumberYesThe ID of the organization to retrieve
includestringNoAdditional related data to include (e.g., lookup_relationship_fields)

List all organizations in Zendesk with pagination support.

NameTypeRequiredDescription
pagenumberNoPage number for pagination
per_pagenumberNoNumber of organizations per page (max 100)

List ticket views in Zendesk. Views are saved filters for organizing tickets by status, assignee, tags, and more.

NameTypeRequiredDescription
pagenumberNoPage number for pagination
per_pagenumberNoNumber of views per page (max 100)
accessstringNoFilter by access level: personal, shared, or account
sort_bystringNoField to sort by: title, updated_at, created_at, or position
sort_orderstringNoSort direction: asc or desc

List all groups in Zendesk. Groups are used to organize agents and route tickets.

NameTypeRequiredDescription
pagenumberNoPage number for pagination
per_pagenumberNoNumber of groups per page (max 100)