How do I use API in Zendesk?
Table of Contents
In your browser, navigate to your Zendesk account. The url will look something like https://your_subdomain.zendesk.com . In Admin Center, click the Apps and integrations icon ( ) in the sidebar, then select APIs > Zendesk APIs. Under the Settings tab, make sure Password Access is enabled in the settings.
What can you do with Zendesk API?
Here are the most common tasks performed with the Zendesk API:

- Creating tickets with a custom ticket form.
- Migrating ticket data into Zendesk Support.
- Creating users in Zendesk Support.
- Searching.
Who can access Zendesk API?
Zendesk Support admins
Only Zendesk Support admins can access the API dashboard. Note: Trial accounts are limited to a maximum of two targets.
Does Zendesk have APIs?
Zendesk’s APIs are organized around REST. Our APIs have predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. If you are new to the Zendesk APIs, take a look at our Beginners Guide.

What is API in Zendesk?
The API is a powerful resource that many of our customers use to bulk-import resources, create apps, pull data to external sources, and more. Most of the reference documentation for the Zendesk API is available in the API reference section of the Zendesk Developer Portal.
How do I pull data from Zendesk API?
Getting data from your Zendesk product
- import requests # Set the request parameters url = ‘https://your_subdomain.zendesk.com/api/v2/groups.json’ user = ‘your_email_address’ pwd = ‘your_password’ # Do the HTTP get request response = requests.
- user = ‘your_email_address’ + ‘/token’ pwd = ‘your_api_token’
What can a light agent do in Zendesk?
Light agents have limited permissions but can stay informed about tickets and, when needed, provide subject matter expertise and advice by adding private comments to the ticket. All ticket comments by light agents are private, including the first comment of any tickets they create.
What are user fields in Zendesk?
Admins and agents with permissions can create custom user fields and add them to user profiles to store additional customer details. Custom user fields are visible to all agents and are editable by agents with access to all tickets. End users cannot see or edit custom user fields.
Where is my Zendesk API key?
How to Find Your Zendesk API Key
- Click the Admin icon in the sidebar, followed by select Channels > API.
- Click the Settings tab and make sure Token Access is enabled.
- Click the + button to the right of Active API Tokens.
- Copy the token. Note, once you close this window, the full token will never be displayed again.
How do I export a user from Zendesk?
There are three options available for you to export a list of users from your account.
- Use the Zendesk Rest API Users endpoint to capture the list of users from your account.
- Export users in XML or JSON format.
- Accounts with the customer lists can export their user list in a CSV file.