How to get field IDs from HappyFox

Field IDs are required when you are trying to access HappyFox API to automate your workflows. While Ticket ID is displayed on the ticket list and ticket details page, to find the IDs of other properties in the app, you may have to query the API.

How to get field IDs from HappyFox API?

1. Go to Manage >> Integration >> API and set up an API key.

2. Open a new tab in the browser.

3. Provide the endpoint URL* and in the address bar and load.

4. When the browser prompt asks for authentication, provide API Key as ID and Auth Code as Password.

You'll see a json dictionary, that contains detailed information on the properties* in your account along with their IDs.

* Property: Properties like Custom fields, Staff, etc.

*Endpoint URL: Depending on which property you need query the below respective end point:

Ticket Category - https://<subdomain>.happyfox.com/api/1.1/json/categories/

Staff - https://<subdomain>.happyfox.com/api/1.1/json/staff/

Contacts - https://<subdomain>.happyfox.com/api/1.1/json/users/?size=<size>&page=<page>

size: (minimum 10, maximum 50, default 10)

Ticket Custom fields - https://<subdomain>.happyfox.com/api/1.1/json/ticket_custom_fields/

Contact Custom fields - https://<subdomain>.happyfox.com/api/1.1/json/user_custom_fields/

Staff - https://<subdomain>.happyfox.com/api/1.1/json/staff/

More GET endpoints are available with example responses here - http://www.happyfox.com/developers/api/1.1/

  • 541
  • 26-Dec-2016
  • 338 Views