> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atako.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Zendesk

> Connect Zendesk to your Atako agents — 19 read and 9 write actions.

Let your agents work your Zendesk helpdesk — read, create, update and search tickets, manage users and organizations, and browse Help Center content.

## Connection

* **Authentication**: API key (email:api\_token).
* **Required settings**:
  * **Subdomain** — yourcompany in yourcompany.zendesk.com

<Note>
  Zendesk Admin Center → Apps and integrations → APIs → Zendesk API → enable "Token access" → Add API token → copy the token. Paste the email of the Zendesk agent the token belongs to and the token joined by a colon: [you@company.com](mailto:you@company.com):api\_token. Tokens inherit that user's role — an Agent role is enough for tickets; Help Center management needs a Guide admin.

  See [Zendesk's documentation](https://support.zendesk.com/hc/en-us/articles/4408889192858-Managing-access-to-the-Zendesk-API).
</Note>

## Read actions (19)

| Action                | Description                                                                                     |
| --------------------- | ----------------------------------------------------------------------------------------------- |
| `get_article`         | Fetch a single Help Center article by id, including its HTML body.                              |
| `get_group`           | Fetch a single agent group by id.                                                               |
| `get_organization`    | Fetch a single organization by id, including domains and tags.                                  |
| `get_ticket`          | Fetch a single ticket by id, including status, assignee and priority.                           |
| `get_ticket_comments` | List the comments (conversation) of a ticket, oldest first by default.                          |
| `get_ticket_field`    | Fetch a single ticket field by id, including its options for dropdowns.                         |
| `get_ticket_form`     | Fetch a single ticket form by id, including its ordered field ids.                              |
| `get_user`            | Fetch a single user by id, including role, email and organization.                              |
| `list_articles`       | List Help Center articles, optionally filtered by labels or sorted.                             |
| `list_groups`         | List agent groups in the account.                                                               |
| `list_macros`         | List ticket macros, optionally only active ones or those of a group.                            |
| `list_organizations`  | List organizations in the account.                                                              |
| `list_ticket_fields`  | List the ticket fields defined in the account (system and custom).                              |
| `list_ticket_forms`   | List ticket forms, optionally only active or end-user-visible ones.                             |
| `list_tickets`        | List tickets in the account, optionally sorted or filtered by external id.                      |
| `list_users`          | List users in the account, optionally filtered by role.                                         |
| `list_views`          | List shared and personal ticket views, optionally only active ones.                             |
| `search_tickets`      | Search tickets with the Zendesk query syntax (e.g. "status:open priority:high").                |
| `search_users`        | Search users by name, email or user field (e.g. "[jane@example.com](mailto:jane@example.com)"). |

## Write actions (9)

| Action                | Description                                                                              |
| --------------------- | ---------------------------------------------------------------------------------------- |
| `create_category`     | Create a Help Center category in a given locale.                                         |
| `create_organization` | Create an organization, optionally mapping email domains to it.                          |
| `create_section`      | Create a Help Center section inside a category, in a given locale.                       |
| `create_ticket`       | Create a ticket with a subject and a first comment, optionally assigned and prioritized. |
| `create_user`         | Create a user (end user or agent) with a name and optional email/role.                   |
| `delete_user`         | Soft-delete a user by id (the user can no longer sign in or be assigned).                |
| `update_organization` | Update an organization's name, domains, notes or tags.                                   |
| `update_ticket`       | Update a ticket: change status/assignee/priority/tags and optionally add a comment.      |
| `update_user`         | Update a user's profile fields (name, email, organization, notes…).                      |

## Permissions

Every action above must be explicitly granted to an agent before it can be used. See [Permissions](/integrations/permissions) for the grant model and [Security](/integrations/security) for how credentials are protected.