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

# Zendesk (Helpdesk)

> Integrate your application with the Zendesk API

## 🚀 Quickstart

Connect to Zendesk with Nango and see data flow in 2 minutes.

**1. Create an integration**

In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Zendesk*.

> [!NOTE]
>
> Nango has a [Nango-managed OAuth app](https://nango.dev/docs/guides/auth/auth-guide.md#nango-managed-oauth-apps) you can use in development and production. Select it when you create the integration.

**2. Authorize Zendesk**

Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to Zendesk. Later, you'll let your users do the same directly from your app.

**3. Call the Zendesk API**

Let's make your first request to the Zendesk API (fetch a list of tickets). Replace the placeholders below with your [Environment API key](https://nango.dev/docs/reference/backend/http-api/api-keys.md), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

> [tab] cURL
>
> ```bash theme={null}
> curl "https://api.nango.dev/proxy/api/v2/search?query=type:ticket&per_page=10" \
>   -H "Authorization: Bearer <NANGO-API-KEY>" \
>   -H "Provider-Config-Key: <INTEGRATION-ID>" \
>   -H "Connection-Id: <CONNECTION-ID>"
> ```

> [tab] Node
>
> Install Nango's backend SDK with `npm i @nangohq/node`. Then run:
>
> ```typescript theme={null}
> import { Nango } from '@nangohq/node';
>
> const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });
>
> const res = await nango.get({
>     endpoint: '/api/v2/search',
>     params: {
>       query: 'type:ticket',
>       per_page: 10
>     },
>     providerConfigKey: '<INTEGRATION-ID>',
>     connectionId: '<CONNECTION-ID>'
> });
>
> console.log(JSON.stringify(res.data, null, 2));
> ```

Or fetch credentials dynamically via the [Node SDK](https://nango.dev/docs/reference/backend/backend-sdk/node.md#get-a-connection-with-credentials) or [API](https://nango.dev/docs/reference/backend/http-api/connections/get.md).

✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.

**4. Implement Nango in your app**

Follow our [Auth implementation guide](https://nango.dev/docs/guides/primitives/auth.md) to integrate Nango in your app.

To use your own OAuth app instead of the Nango-managed one, follow the setup guide linked below.

## 📚 Zendesk Integration Guides

Nango maintained guides for common use cases.

* [How to register your own Zendesk OAuth app](https://nango.dev/docs/api-integrations/zendesk/how-to-register-your-own-zendesk-api-oauth-app)\
  Register an OAuth app with Zendesk and obtain credentials to connect it to Nango

* [How do I link my Zendesk account?](https://nango.dev/docs/api-integrations/zendesk/connect)\
  Learn how to authenticate with Zendesk and link your account

Official docs: [Zendesk API documentation](https://developer.zendesk.com/api-reference/)

## 🧩 Pre-built syncs & tools for Zendesk

Explore Nango-provided tools in your dashboard. Extend and customize them to fit your needs.

### Groups

| Function name | Description | Type |
| - | - | - |
| `groups` | Sync support groups from Zendesk. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

### Others

| Function name | Description | Type |
| - | - | - |
| `create-category` | Create a Zendesk Help Center category | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-organization` | Create an organization in Zendesk Support | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-section` | Create a Zendesk Help Center section | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-ticket` | Create a support ticket in Zendesk | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-user` | Create a user in Zendesk Support. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-user` | Delete a Zendesk user | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-article` | Retrieve a Zendesk Help Center article by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-group` | Retrieve a group by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-organization` | Retrieve an organization by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-ticket-comments` | List comments for a ticket. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-ticket-field` | Retrieve a ticket field by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-ticket-form` | Retrieve a ticket form by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-ticket` | Retrieve a ticket by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-user` | Retrieve a user by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-articles` | List Zendesk Help Center articles with pagination | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-groups` | List support groups | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-macros` | List ticket macros available to the account | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-organizations` | List organizations in Zendesk Support. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-ticket-fields` | List ticket fields for the account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-ticket-forms` | List ticket forms for the account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-tickets` | List tickets in Zendesk Support | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-users` | List users in Zendesk Support. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-views` | List ticket views for the account | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search-tickets` | Search tickets with Zendesk search syntax. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-organization` | Update an existing organization in Zendesk. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-ticket` | Update an existing ticket and optionally add a comment | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-user` | Update an existing user. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `articles` | Sync Zendesk Help Center articles | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `categories` | Sync Zendesk Help Center categories | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `macros` | Sync ticket macros from Zendesk | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `organizations` | Sync organizations from Zendesk using incremental export | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `sections` | Sync Zendesk Help Center sections | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `ticket-comments` | Sync comments for tickets provided in metadata | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `ticket-fields` | Sync ticket field definitions from Zendesk | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `ticket-forms` | Sync ticket forms from Zendesk | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `tickets` | Sync tickets from Zendesk Support | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `users` | Sync users from Zendesk Support using incremental cursor-based exports | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `views` | Sync ticket views from Zendesk | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.