Freshdesk APIs allow you to connect, interact and integrate with the Freshdesk Help Desk, directly. Freshdesk APIs belong to the REpresentational State Transfer (REST) API category and allow you to read, modify, add and delete data in your Freshdesk helpdesk. Tickets, Users, Forums, Forums, Solutions, Companies and Time entries are the Freshdesk resources that you can manipulate using the appropriate APIs.
Freshdesk APIs are intended for the Developer fraternity that would like other applications to interact with Freshdesk Help Desk. In addition, these APIs could be combined with any other third party application to create powerful ‘Mashups’. Long story short - if you are a developer, continue reading; you’ll find this document useful to understand the Freshdesk APIs. cURL (a good open source tool is hurl) to view all Freshdesk REST API requests.
Let’s try out an example. Assume, your support portal is “example.freshdesk.com” and you want to access the ‘contacts’ in your help desk using APIs, then the syntax would be:
One exception though is the ‘tickets’ resource:
It is mandatory to authenticate your identity to execute the API commands for Freshdesk. You can do this by using either your Freshdesk’s username and password or API Key and password. If you are using the API key, make sure you use default password, ‘X’. Also, your user profile needs to have ‘write’ permissions to execute this command.
You can find the API key under,
"User Profile" drop-down (top right corner of your helpdesk) > Profile Settings > Your API Key
Your data accessibility level will greatly depend on the permissions of your Freshdesk user profile.
Now, let’s assume your user profile has only ‘read’ permissions, then you will be restricted to only view the resources using the Freshdesk API commands.
Freshdesk APIs have been implemented as plain XML or JSON over HTTP and use the following REST Commands:
|Use this command||To do this|
|POST||Create one or more items|
|GET||Fetch one or more items|
|PUT||Update one or more existing items|
|DELETE||Remove one or more items that already exist|
Now that we have covered the basics of Freshdesk APIs; it’s time to take a closer look at the API codes.