You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
API for HappyFox
print icon

HappyFox provides you with RESTful APIs where you can create a ticket, add updates to a ticket, list tickets and users and much more.  JSON, Form Urlencoded and Multipart Form Data are the supported formats for the APIs.

 

What you need, how you can use it, API version, Resource URI and all other information can be found here on this exclusive page for APIs


 

 

If your HappyFox account is hosted in EU, please use <account_name>.happyfox.net

 

Other commonly used endpoints are listed below.

 

API key and auth code are to be passed in Basic HTTP authentication format only.

 

1. List categories

 

API Endpoint: https://<account_name>.happyfox.com/api/1.1/json/categories/

 

Method: GET

 

2. List staffs/agents

 

API Endpoint: https://<account_name>.happyfox.com/api/1.1/json/staff/

 

Method: GET

 

3. List all statuses

 

API Endpoint: https://<account_name>.happyfox.com/api/1.1/json/statuses/

 

Method: GET

 

4. List metadata of all ticket custom fields 

 

API Endpoint: https://<account_name>.happyfox.com/api/1.1/json/ticket_custom_fields/

 

Method: GET

 

5. List metadata of all contact custom fields

 

API Endpoint: https://<account_name>.happyfox.com/api/1.1/json/user_custom_fields/

 

Method: GET

 

6. Export Knowledge Base

 

HTTP Method: GET
 

API Endpoints: 

 

External articles - https://<account_name>.happyfox.com/api/1.1/json/kb/articles/

 

Internal articles - https://<account_name>.happyfox.com/api/1.1/json/kb/internal-articles/

 

All sections - https://<account_name>.happyfox.com/api/1.1/json/kb/sections/


Export single article - https://<account_name>.happyfox.com/api/1.1/json/kb/article/<id_of_the_article>

 

Export single section - https://<account_name>.happyfox.com/api/1.1/json/kb/section/<id_of_the_section>

 

The above url allows you to access one article a time, using the article id provided from the /articles/ endpoint in the previous step. This is applicable only for external articles.

 

Feedback
19 out of 27 found this helpful

scroll to top icon