Turning on and off API access

What's my plan?

All Suites

Team, Growth, Professional, Enterprise, or Enterprise Plus

Support

Team, Professional, or Enterprise

Verified AI summary ◀▼

To manage API access, activate API tokens to protect agent passwords. You can enable or disable token access in the Admin Center under API configuration. API token access is off by default, so you need to turn it on before generating tokens. Disabling token access will deactivate existing tokens, requiring reactivation to use them again.

Location: Admin Center > Apps and integrations > APIs > API configuration

Users can access the Zendesk API using these authentication methods:

• They can use an auto-generated password called an API token.
• They can use an OAuth access token, which is different from an API token.

Use the API configuration page to turn on password and API token access to the Zendesk API. For OAuth access, see Using OAuth authentication with your application. For more information about the Zendesk API, see the Zendesk Developer Documentation.

This article includes these sections:

• Activating API access
• Turning on and off API access

Related articles:

• Managing access to the Zendesk API

Activating API access

If you’re accessing the Zendesk API for the first time, you need to accept the Zendesk Terms of Service and the Application Developer and API Agreement.

To activate API access

1. In Admin Center, click Apps and integrations in the sidebar, then select APIs > API configuration.
2. Click the checkbox to accept the terms and agreements.
3. Click Get started.

   

Turning on and off API token access

You use API tokens to keep your agent’s passwords safe. When authenticating with tokens, add /token to the end of your email address.API token access is disabled by default. You must enable API token access before users can use API tokens.

Note: Some older accounts may include a setting for activating API password access (in addition to API token access). API password access has been deprecated and is not supported in new accounts.

To turn on token access to the API

1. In Admin Center, click Apps and integrations in the sidebar, then select APIs > API configuration.
2. Select Allow API token access.

   After you turn on API token access, you can generate API access tokens. See Generating API tokens.

To turn off token access to the API

1. In Admin Center, click Apps and integrations in the sidebar, then select APIs > API configuration.
2. Deselect Allow API token access.

   When you turn off token access, your tokens stop working. You’ll need to turn token access back on to reactivate them.