Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Zendesk (OAUTH) connector

OAuth 2.0Customer SupportCommunication

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

Zendesk (OAUTH) connector

  1. Install the SDK

    Section titled “Install the SDK”
    Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Set your credentials

    Section titled “Set your credentials”

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>

  3. Set up the connector

    Section titled “Set up the connector”

    Register your Zendesk (OAUTH) credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

    Dashboard setup steps

    Register your Scalekit environment with Zendesk so Scalekit can handle the OAuth flow and token lifecycle for your users.

    1. Copy the redirect URI from Scalekit

      • In the Scalekit dashboard, go to AgentKit > Connections > Create Connection.
      • Search for Zendesk (OAUTH) and click Create.
      • Copy the Redirect URI from the connection details panel. It looks like: 
        https://<YOUR_ENV>.scalekit.cloud/sso/v1/oauth/conn_<ID>/callback

    2. Create an OAuth client in Zendesk

      • Sign in to your Zendesk account and open Admin Center.
      • In the left sidebar, go to Apps and integrations > APIs > OAuth clients.

      Zendesk Admin Center showing the OAuth clients list with an Add OAuth client button

      • Click Add OAuth client (top right).

    3. Fill in the client details

      • Enter a Name (shown to users during authorization, for example Agent Connect) and a unique Identifier (used in code — for example, agent_connect_auth).
      • Set Client kind to Confidential — this allows Zendesk to issue a client secret.
      • Under Redirect URLs, paste the Scalekit redirect URI you copied in step 1. Add one URL per line.

      Zendesk OAuth client form showing the Identifier field set to agent_connect_auth, Client kind set to Confidential, and Redirect URLs field

    4. Save and copy your credentials

      • Click Save. Zendesk displays the full Secret immediately after saving.

      Zendesk OAuth client form showing the Redirect URLs saved and the Secret field

      Note both values:

      • Client ID — the Identifier you entered (for example, agent_connect_auth)
      • Client Secret — the value shown in the Secret field

    5. Add credentials in Scalekit

      • Return to Scalekit dashboard and open the Zendesk (OAUTH) connection you created.
      • Enter:
        • Client ID — the Identifier from your Zendesk OAuth client
        • Client Secret — the Secret shown after saving
      • Click Save.

  4. Authorize and make your first call

    Section titled “Authorize and make your first call”
    quickstart.ts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    

    const scalekit = new ScalekitClient(
      process.env.SCALEKIT_ENV_URL,
      process.env.SCALEKIT_CLIENT_ID,
      process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    

    const connector = 'zendeskoauth'
    const identifier = 'user_123'
    

    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Zendesk (OAUTH):', link)
    process.stdout.write('Press Enter after authorizing...')
    await new Promise(r => process.stdin.once('data', r))
    

    // Make your first call
    const result = await actions.executeTool({
      connector,
      identifier,
      toolName: 'zendeskoauth_groups_list',
      toolInput: {},
    })
    console.log(result)

What you can do

Section titled “What you can do”

Connect this agent connector to let your agent:

  • Create help center section, help center article comment, help center article — Create a section under a Help Center category
  • Get ticket, help center section, ticket audits — Retrieve details of a specific Zendesk ticket by ID
  • List groups, ticket comments, side conversations — List all groups in Zendesk
  • Update help center article, help center article translation, ticket — Update article-level metadata: promoted status, position, comments setting, labels, and content tags
  • Search help center articles, tickets, guide — Search Help Center articles by keyword
  • Archive help center article — Archive (delete) a Help Center article by ID

Tool list

Section titled “Tool list”

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

zendeskoauth_groups_list#List all groups in Zendesk. Groups are used to organize agents and route tickets.2 params

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

NameTypeRequiredDescription
pagenumberoptionalPage number for pagination
per_pagenumberoptionalNumber of groups per page (max 100)
zendeskoauth_help_center_article_archive#Archive (delete) a Help Center article by ID. The article can be restored from the Zendesk Help Center UI.1 param

Archive (delete) a Help Center article by ID. The article can be restored from the Zendesk Help Center UI.

NameTypeRequiredDescription
article_idnumberrequiredThe ID of the article to archive.
zendeskoauth_help_center_article_comment_create#Add a comment to a Help Center article. Requires article ID, comment body, and locale.5 params

Add a comment to a Help Center article. Requires article ID, comment body, and locale.

NameTypeRequiredDescription
article_idnumberrequiredThe ID of the article to comment on.
bodystringrequiredHTML body of the comment.
localestringrequiredLocale for the comment (e.g., en-us).
author_idnumberoptionalUser ID of the comment author (Help Center managers only).
notify_subscribersbooleanoptionalWhether to notify article subscribers of the new comment. Default: true.
zendeskoauth_help_center_article_comments_list#List all comments on a Help Center article.5 params

List all comments on a Help Center article.

NameTypeRequiredDescription
article_idnumberrequiredThe ID of the article whose comments to list.
includestringoptionalComma-separated sideloads: users (authors), articles.
pageintegeroptionalPage number for offset pagination.
per_pageintegeroptionalNumber of results per page (max 100).
sort_orderstringoptionalSort direction: asc or desc. Default: desc.
zendeskoauth_help_center_article_create#Create a new Help Center article in a section. Requires a title, locale, and section ID.12 params

Create a new Help Center article in a section. Requires a title, locale, and section ID.

NameTypeRequiredDescription
localestringrequiredLocale for the article (e.g., en-us).
section_idnumberrequiredThe ID of the section to create the article in.
titlestringrequiredThe title of the article.
author_idnumberoptionalUser ID of the article author.
bodystringoptionalHTML body content of the article.
comments_disabledbooleanoptionalWhether to disable comments on this article.
content_tag_idsarrayoptionalIDs of existing content tags to attach to the article.
draftbooleanoptionalIf true, the article is saved as a draft and not published.
notify_subscribersbooleanoptionalSet to false to suppress email notifications to article subscribers on creation. Default: true.
permission_group_idnumberoptionalThe permission group that determines who can view this article.
promotedbooleanoptionalWhether to pin this article to the top of its section.
user_segment_idnumberoptionalThe user segment that can view this article. Omit for a public article.
zendeskoauth_help_center_article_get#Retrieve a single Help Center article by its ID.2 params

Retrieve a single Help Center article by its ID.

NameTypeRequiredDescription
article_idnumberrequiredThe ID of the article to retrieve.
includestringoptionalComma-separated sideloads: users, sections, categories, translations.
zendeskoauth_help_center_article_labels_list#List all labels attached to a specific Help Center article.3 params

List all labels attached to a specific Help Center article.

NameTypeRequiredDescription
article_idstringrequiredThe ID of the article to retrieve labels for.
pageintegeroptionalPage number for offset pagination.
per_pageintegeroptionalNumber of results per page (max 100).
zendeskoauth_help_center_article_translation_update#Update a Help Center article translation's title, body, draft status, or outdated flag for a given locale. This is the only way to edit article content — the article-level update endpoint does not accept title or body.6 params

Update a Help Center article translation's title, body, draft status, or outdated flag for a given locale. This is the only way to edit article content — the article-level update endpoint does not accept title or body.

NameTypeRequiredDescription
article_idnumberrequiredThe unique ID of the article whose translation to update.
localestringrequiredThe locale of the translation to update.
bodystringoptionalNew HTML body content for the translation.
draftbooleanoptionalIf true, saves the translation as a draft and unpublishes it.
outdatedbooleanoptionalIf true, marks the translation as outdated.
titlestringoptionalNew title for the translation.
zendeskoauth_help_center_article_update#Update article-level metadata: promoted status, position, comments setting, labels, and content tags. Does not update title or body — use the Translations API for those.6 params

Update article-level metadata: promoted status, position, comments setting, labels, and content tags. Does not update title or body — use the Translations API for those.

NameTypeRequiredDescription
article_idnumberrequiredThe ID of the article to update.
comments_disabledbooleanoptionalWhether to disable comments on this article.
content_tag_idsarrayoptionalIDs of content tags to attach to the article.
label_namesarrayoptionalLabels to assign to the article.
positionintegeroptionalPosition of the article within its section.
promotedbooleanoptionalWhether to pin this article to the top of its section.
zendeskoauth_help_center_articles_list#List Help Center articles. Filter by section or category, sort, and paginate results.7 params

List Help Center articles. Filter by section or category, sort, and paginate results.

NameTypeRequiredDescription
includestringoptionalComma-separated sideloads: users, sections, categories, translations.
label_namesstringoptionalComma-separated list of labels to filter articles by.
pageintegeroptionalPage number for offset pagination.
per_pageintegeroptionalNumber of results per page (max 100).
sort_bystringoptionalField to sort by: position, title, created_at, updated_at, or edited_at.
sort_orderstringoptionalSort direction: asc or desc.
start_timeintegeroptionalUnix epoch timestamp to fetch only articles updated after this time (for incremental sync).
zendeskoauth_help_center_categories_list#List all Help Center categories in your Zendesk account. Returns categories with IDs, names, and positions.5 params

List all Help Center categories in your Zendesk account. Returns categories with IDs, names, and positions.

NameTypeRequiredDescription
includestringoptionalSideload related data. Use 'translations' to include category translations.
pageintegeroptionalPage number for offset pagination.
per_pageintegeroptionalNumber of results per page (max 100).
sort_bystringoptionalField to sort by: position, created_at, or updated_at.
sort_orderstringoptionalSort direction: asc or desc.
zendeskoauth_help_center_category_get#Retrieve a single Help Center category by its ID.2 params

Retrieve a single Help Center category by its ID.

NameTypeRequiredDescription
category_idnumberrequiredThe ID of the category to retrieve.
includestringoptionalSideload related data. Use 'translations' to include category translations.
zendeskoauth_help_center_labels_list#List all Help Center labels in the account. Returns label names and article counts. Supports pagination.2 params

List all Help Center labels in the account. Returns label names and article counts. Supports pagination.

NameTypeRequiredDescription
pageintegeroptionalPage number for offset pagination.
per_pageintegeroptionalNumber of results per page (max 100).
zendeskoauth_help_center_section_create#Create a section under a Help Center category. Supply name and locale for a single-locale section, or a translations array for multi-locale (the two patterns are mutually exclusive). Nesting under parent_section_id requires a Guide plan that supports nested sections.11 params

Create a section under a Help Center category. Supply name and locale for a single-locale section, or a translations array for multi-locale (the two patterns are mutually exclusive). Nesting under parent_section_id requires a Guide plan that supports nested sections.

NameTypeRequiredDescription
category_idnumberrequiredThe unique ID of the category to create the section in.
descriptionstringoptionalAn optional description of the section.
localestringoptionalThe locale for the section. Required when not using translations.
manageable_bystringoptionalWho can manage this section.
namestringoptionalThe name of the section. Required when not using translations.
parent_section_idnumberoptionalID of a parent section to nest this section under. Requires a Guide plan that supports nested sections.
positionintegeroptionalPosition of the section within its category for manual ordering.
sortingstringoptionalSort order for articles within this section.
theme_templatestringoptionalThe template this section uses in the Help Center theme.
translationsarrayoptionalAdditional locale translations for the section. Each item must have a locale, title, and optional body.
user_segment_idnumberoptionalThe user segment that can view this section. Omit for a public section.
zendeskoauth_help_center_section_get#Retrieve a single Help Center section by its ID.2 params

Retrieve a single Help Center section by its ID.

NameTypeRequiredDescription
section_idnumberrequiredThe ID of the section to retrieve.
includestringoptionalComma-separated sideloads: 'categories' to include the parent category, 'translations' to include translations.
zendeskoauth_help_center_sections_list#List all Help Center sections. Filter by category to narrow results.5 params

List all Help Center sections. Filter by category to narrow results.

NameTypeRequiredDescription
includestringoptionalComma-separated sideloads: 'categories' to include the parent category, 'translations' to include translations.
pageintegeroptionalPage number for offset pagination.
per_pageintegeroptionalNumber of results per page (max 100).
sort_bystringoptionalField to sort by: position, created_at, or updated_at.
sort_orderstringoptionalSort direction: asc or desc.
zendeskoauth_organization_get#Retrieve details of a specific Zendesk organization by ID. Returns organization name, domain names, tags, notes, shared ticket settings, and custom fields.2 params

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

NameTypeRequiredDescription
organization_idnumberrequiredThe ID of the organization to retrieve
includestringoptionalAdditional related data to include (e.g., lookup_relationship_fields)
zendeskoauth_organizations_list#List all organizations in Zendesk with pagination support.2 params

List all organizations in Zendesk with pagination support.

NameTypeRequiredDescription
pagenumberoptionalPage number for pagination
per_pagenumberoptionalNumber of organizations per page (max 100)
zendeskoauth_satisfaction_ratings_list#List CSAT satisfaction ratings with optional filters. Returns score (good/bad), comment, reason, ticket ID, and timestamps for each rating.7 params

List CSAT satisfaction ratings with optional filters. Returns score (good/bad), comment, reason, ticket ID, and timestamps for each rating.

NameTypeRequiredDescription
end_timenumberoptionalUnix timestamp to filter ratings created before this time
pagenumberoptionalPage number for pagination
per_pagenumberoptionalNumber of results per page
schema_versionstringoptionalVersion of the tool schema
scorestringoptionalFilter by satisfaction score
start_timenumberoptionalUnix timestamp to filter ratings created after this time
tool_versionstringoptionalVersion of the tool
zendeskoauth_satisfaction_reasons_list#List all satisfaction reasons configured for negative (bad) CSAT ratings. Used to analyze why customers rate support interactions poorly.2 params

List all satisfaction reasons configured for negative (bad) CSAT ratings. Used to analyze why customers rate support interactions poorly.

NameTypeRequiredDescription
schema_versionstringoptionalVersion of the tool schema
tool_versionstringoptionalVersion of the tool
zendeskoauth_search_tickets#Search Zendesk tickets using a query string. Supports Zendesk's search syntax (e.g., 'type:ticket status:open'). Zendesk limits search results to 1,000 total — the maximum valid page is floor(1000 / per_page) (e.g., per_page=100 → max page 10, per_page=25 → max page 40). Stop paginating when next_page is null or you reach the max page; requesting beyond the limit returns a 400 error.6 params

Search Zendesk tickets using a query string. Supports Zendesk's search syntax (e.g., 'type:ticket status:open'). Zendesk limits search results to 1,000 total — the maximum valid page is floor(1000 / per_page) (e.g., per_page=100 → max page 10, per_page=25 → max page 40). Stop paginating when next_page is null or you reach the max page; requesting beyond the limit returns a 400 error.

NameTypeRequiredDescription
querystringrequiredSearch query string using Zendesk search syntax (e.g., 'type:ticket status:open assignee:me')
includestringoptionalComma-separated list of additional data to sideload with results. Supported values: users, groups, organizations, tickets.
pagenumberoptionalPage number for pagination. Max valid page = floor(1000 / per_page). Do not exceed this — Zendesk returns a 400 error beyond the 1,000 result limit.
per_pagenumberoptionalNumber of results per page (max 100). Determines the max page ceiling: floor(1000 / per_page). Higher values mean fewer pages but a lower max page number.
sort_bystringoptionalField to sort results by (updated_at, created_at, priority, status, ticket_type)
sort_orderstringoptionalSort direction: asc or desc (default: desc)
zendeskoauth_side_conversation_get#Retrieve a specific side conversation on a Zendesk ticket by its ID. Returns the side conversation's state, subject, participants, preview text, and timestamps. Requires the Collaboration add-on.3 params

Retrieve a specific side conversation on a Zendesk ticket by its ID. Returns the side conversation's state, subject, participants, preview text, and timestamps. Requires the Collaboration add-on.

NameTypeRequiredDescription
side_conversation_idstringrequiredThe ID of the side conversation to retrieve
ticket_idnumberrequiredThe ID of the parent ticket
includestringoptionalSideloads to include alongside the response. Use 'side_conversation_events' to include the full event history of the side conversation.
zendeskoauth_side_conversations_list#List all side conversations on a Zendesk ticket. Returns side conversations including their state, subject, participants, and preview text. Requires the Collaboration add-on.2 params

List all side conversations on a Zendesk ticket. Returns side conversations including their state, subject, participants, and preview text. Requires the Collaboration add-on.

NameTypeRequiredDescription
ticket_idnumberrequiredThe ID of the ticket whose side conversations to list
includestringoptionalSideloads to include alongside the response. Use 'side_conversation_events' to include the full event history for each side conversation.
zendeskoauth_sla_policies_list#List all SLA policy definitions including policy name, conditions, and filter criteria. Requires Professional or Enterprise plan.2 params

List all SLA policy definitions including policy name, conditions, and filter criteria. Requires Professional or Enterprise plan.

NameTypeRequiredDescription
schema_versionstringoptionalVersion of the tool schema
tool_versionstringoptionalVersion of the tool
zendeskoauth_ticket_audits_get#Retrieve the full audit trail for a specific ticket including all field changes, status transitions, comments, and timestamps.6 params

Retrieve the full audit trail for a specific ticket including all field changes, status transitions, comments, and timestamps.

NameTypeRequiredDescription
ticket_idnumberrequiredThe ID of the ticket to retrieve audits for
page_afterstringoptionalCursor for next page.
page_sizeintegeroptionalNumber of records per page. Maximum 100.
schema_versionstringoptionalVersion of the tool schema
sort_orderstringoptionalSort order for audit events.
tool_versionstringoptionalVersion of the tool
zendeskoauth_ticket_audits_list#List audit trail events across all tickets including field changes, status transitions, assignment changes, and timestamps. Useful for tracking time-in-status and escalation paths.5 params

List audit trail events across all tickets including field changes, status transitions, assignment changes, and timestamps. Useful for tracking time-in-status and escalation paths.

NameTypeRequiredDescription
page_afterstringoptionalCursor for next page (cursor-based pagination).
page_beforestringoptionalCursor for previous page (cursor-based pagination).
page_sizeintegeroptionalNumber of records per page. Maximum 100.
schema_versionstringoptionalVersion of the tool schema
tool_versionstringoptionalVersion of the tool
zendeskoauth_ticket_comments_list#Retrieve all comments (public replies and internal notes) for a specific Zendesk ticket. Returns comment body, author, timestamps, and attachments.4 params

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

NameTypeRequiredDescription
ticket_idnumberrequiredThe ID of the ticket whose comments to list
includestringoptionalSideloads to include. Accepts 'users' to list email CCs.
include_inline_imagesbooleanoptionalWhen true, inline images are listed as attachments (default: false)
sort_orderstringoptionalSort direction for comments: asc or desc (default: asc)
zendeskoauth_ticket_create#Create a new support ticket in Zendesk. Requires a comment/description and optionally a subject, priority, assignee, and tags.7 params

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

NameTypeRequiredDescription
comment_bodystringrequiredThe description or first comment of the ticket
assignee_emailstringoptionalEmail of the agent to assign the ticket to
prioritystringoptionalTicket priority: urgent, high, normal, or low
statusstringoptionalTicket status: new, open, pending, hold, solved, or closed
subjectstringoptionalThe subject/title of the ticket
tagsarrayoptionalList of tags to apply to the ticket
typestringoptionalTicket type: problem, incident, question, or task
zendeskoauth_ticket_get#Retrieve details of a specific Zendesk ticket by ID. Returns ticket properties including status, priority, subject, requester, assignee, and timestamps.2 params

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

NameTypeRequiredDescription
ticket_idnumberrequiredThe ID of the ticket to retrieve
includestringoptionalComma-separated list of sideloads to include (e.g., users, groups, organizations)
zendeskoauth_ticket_metric_events#Incrementally export ticket metric events (reply times, agent work times, requester wait times) for time-series analysis. Returns event-level granularity for SLA compliance tracking.6 params

Incrementally export ticket metric events (reply times, agent work times, requester wait times) for time-series analysis. Returns event-level granularity for SLA compliance tracking.

NameTypeRequiredDescription
start_timenumberrequiredUnix timestamp to start incremental export from
exclude_deletedbooleanoptionalWhen true, removes metric events tied to deleted tickets.
include_changesbooleanoptionalWhen true, includes additional change data for more accurate incremental results.
per_pagenumberoptionalNumber of results per page
schema_versionstringoptionalVersion of the tool schema
tool_versionstringoptionalVersion of the tool
zendeskoauth_ticket_metrics_get#Retrieve ticket metrics for a specific ticket including reply time, resolution time, wait times, reopen count, and assignee/group station counts.3 params

Retrieve ticket metrics for a specific ticket including reply time, resolution time, wait times, reopen count, and assignee/group station counts.

NameTypeRequiredDescription
ticket_idnumberrequiredThe ID of the ticket to retrieve metrics for
schema_versionstringoptionalVersion of the tool schema
tool_versionstringoptionalVersion of the tool
zendeskoauth_ticket_metrics_list#List ticket metrics for all tickets in the Zendesk account. Returns first reply time, resolution time, agent wait time, requester wait time, reply count, and reopen count.4 params

List ticket metrics for all tickets in the Zendesk account. Returns first reply time, resolution time, agent wait time, requester wait time, reply count, and reopen count.

NameTypeRequiredDescription
pagenumberoptionalPage number for pagination
per_pagenumberoptionalNumber of results per page
schema_versionstringoptionalVersion of the tool schema
tool_versionstringoptionalVersion of the tool
zendeskoauth_ticket_reply#Add a public reply or internal note to a Zendesk ticket. Set public to false for internal notes visible only to agents.3 params

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

NameTypeRequiredDescription
bodystringrequiredThe reply message content (plain text, markdown supported)
ticket_idnumberrequiredThe ID of the ticket to reply to
publicbooleanoptionalWhether the comment is public (true) or an internal note (false). Defaults to true.
zendeskoauth_ticket_update#Update an existing Zendesk ticket. Change status, priority, assignee, subject, tags, or any other writable ticket field.9 params

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

NameTypeRequiredDescription
ticket_idnumberrequiredThe ID of the ticket to update
assignee_emailstringoptionalEmail of the agent to assign the ticket to
assignee_idnumberoptionalID of the agent to assign the ticket to
group_idnumberoptionalID of the group to assign the ticket to
prioritystringoptionalTicket priority: urgent, high, normal, or low
statusstringoptionalTicket status: new, open, pending, hold, solved, or closed
subjectstringoptionalNew subject/title for the ticket
tagsarrayoptionalList of tags to set on the ticket (replaces existing tags)
typestringoptionalTicket type: problem, incident, question, or task
zendeskoauth_tickets_list#List tickets in Zendesk with sorting and pagination. Returns tickets for the authenticated agent's account.4 params

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

NameTypeRequiredDescription
pagenumberoptionalPage number for pagination
per_pagenumberoptionalNumber of tickets per page (max 100)
sort_bystringoptionalField to sort by: created_at, updated_at, priority, status, ticket_type
sort_orderstringoptionalSort direction: asc or desc (default: desc)
zendeskoauth_user_create#Create a new user in Zendesk. Can create end-users (customers), agents, or admins. Email is required for end-users.6 params

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

NameTypeRequiredDescription
namestringrequiredFull name of the user
emailstringoptionalPrimary email address of the user
organization_idnumberoptionalID of the organization to associate the user with
phonestringoptionalPrimary phone number (E.164 format, e.g. +15551234567)
rolestringoptionalUser role: end-user, agent, or admin. Defaults to end-user.
verifiedbooleanoptionalWhether the user's identity is verified. Defaults to false.
zendeskoauth_user_get#Retrieve details of a specific Zendesk user by ID. Returns user profile including name, email, role, organization, and account status.2 params

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

NameTypeRequiredDescription
user_idnumberrequiredThe ID of the user to retrieve
includestringoptionalComma-separated list of sideloads to include
zendeskoauth_users_list#List users in Zendesk. Filter by role (end-user, agent, admin) with pagination support.4 params

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

NameTypeRequiredDescription
pagenumberoptionalPage number for pagination
per_pagenumberoptionalNumber of users per page (max 100)
rolestringoptionalFilter by role: end-user, agent, or admin
sortstringoptionalField to sort by. Prefix with - for descending (e.g. -created_at)
zendeskoauth_views_list#List ticket views in Zendesk. Views are saved filters for organizing tickets by status, assignee, tags, and more.5 params

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

NameTypeRequiredDescription
accessstringoptionalFilter by access level: personal, shared, or account
pagenumberoptionalPage number for pagination
per_pagenumberoptionalNumber of views per page (max 100)
sort_bystringoptionalField to sort by: title, updated_at, created_at, or position
sort_orderstringoptionalSort direction: asc or desc