API tokens can be used to as part of 2-factor authentication for integrations. API tokens can be used by anyone on the account and aren't associated with specific users. Admins can view, add, delete, and manage API tokens in the Zendesk Admin interface. To generate an API token, you must be an administrator and API token access must be enabled.
This article includes the following sections:
Enabling API token access
API token access is disabled by default. Before you can generate an API token, enable API token access.
To enable API token access
- In Admin Center, click
Apps and integrations in the sidebar, then select APIs > Zendesk APIs. - Click the Token Access toggle to enable API token access.
Generating an API token
Once you have enabled API token access, admins can generate an API token.
To generate an API token
- In Admin Center, click Apps and integrations in the sidebar, then select APIs > Zendesk APIs.
- Click the Settings tab, and make sure Token Access is enabled.
- Click the Add API token button to the right of Active API Tokens.
The token is generated and displayed.
- Enter an API token description.
- Copy the token and paste it somewhere secure. Once you close this window, the full token will never be displayed again.
- Click Save to return to the API page.
If you click the token to reopen it, a truncated version of the token is displayed.
9 Comments
Hello we recently had to setup a new token and it doesn't appear to be working when we try to use it in our Okta instance. Is anyone else experiencing this issue?
Hey there,
Thanks for reaching out on our community post about your issue with the API Token and your Okta instance. In this situation, what I will be doing is creating a ticket so that we can work on this together internally and see what could be going on. Speak to you soon!
Russell Chee | Senior Customer Advocacy Specialist | Melbourne, Australia
Hi,
Is there any way that I generate an api key with restricted access? I want to write an app and add private comments to tickets, with the api key from customer i would have full access to customer data. I only want to add comments.
Yeah would be good to know Api token with restricted acess
Not sure if there is a documented way but I was able to do this. So after you create the api token under the user you want, you can downgrade the user's role to your custom role. Granted your account has access to create custom roles. The API's should be restricted based on what is defined in that role.
I Agree would be good to know Api token with restricted acess
Hello,
I am login into Admin Center using an admin account. When I go to Apps and Integrations I don't see the APIs Link, but just Salesforce, Event Connector for Amazon EventBridge, Shopify and Slack.
Is it because I need to set up something before reaching Apps and Integrations? Do I need special permissions?
Thank you very much for any pointers you can give me
Andres
You will need to make sure that your role is indeed an Admin once you go to your profile in Admin Center.
There's currently no permission restriction if you are indeed an Admin. If the same issue persisted, please contact our support directly.
I'm following the directions here to back up our KB using the Help Center API.
Our Zendesk requires SSO via Okta to log in, so I've created an API token and placed the following into the script:
credentials = 'your_email@domain.com/token'
but receive error 401.
Is there another way to format the credentials with the script?
Please sign in to leave a comment.