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

# Zendesk

## Required Scopes

To configure a Sync for Zendesk, you need to request the following scopes from your Zendesk OAuth application:

**Files:**

* `hc:read`

**Tickets:**

* `tickets:read`
* `organizations:read`
* `users:read`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Zendesk supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema): Syncs knowledge base articles from Zendesk.
* [Tickets](/managed-sync/api/ticket-schema): Syncs tickets from Zendesk.

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync of knowledge base articles from Zendesk.

```json Example theme={null}
{
    "integration": "zendesk",
    "pipeline": "files",
    "configuration": {
        "locale": "en-us"
    }
}
```

**Configuration options:**

<ParamField path="locale" type="string">
  A locale string to limit the Sync scope to articles in a specific language. If not specified, the Sync will use `en-us` as the default locale.
</ParamField>

## Tickets

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a ticket sync.

```json Example theme={null}
{
    "integration": "zendesk",
    "pipeline": "tickets",
    "configuration": {}
}
```

**Configuration options:**

<ParamField path="organizationId" type="string">
  A Zendesk Organization ID to limit the Sync scope to tickets from a specific organization.

  If not specified, the Sync will ingest all available tickets from the user's Zendesk account.
</ParamField>
