Read All Tickets

URL<base_uri> / <response_format> /tickets/?size=<size>&page=<page>
HTTP MethodGET
Response DataPaginated List of Ticket
Additional Paramssize: number of items per page(minimum 10, maximum 50, default 10)
page: the number of the page required

Data Structure

Read One Ticket

URL<base_uri> / <response_format> /ticket /<id>/
HTTP MethodGET
Response DataTicket

Data Structure

Create a Ticket

To create a ticket make a POST request to the URL below with request data encoded in one of the supported formats. On success it returns the newly created ticket.

NOTE: file attachments are supported only when using Multipart Form Data

URL<base_uri> / <response_format> /tickets/
HTTP Method POST
Request Data Create Ticket or Create Ticket Using User Email & Name
Response Data Ticket

Data Structure

                           

Notes:

Ticket Custom Field Values For Create Ticket

  1. All the points in Common Information For Setting Ticket / User Custom Field Values.
  2. The values for ticket custom fields should be appended to the fields for Create Ticket.
  3. The value for a ticket custom field should be sent using a field name constructed from the ID of the ticket custom field in the following format "t-cf-<id>".
  4. The ticket custom fields applicable to a ticket are dependent on the ticket's category. This can be determined from the "categories" field of Ticket Custom Field.

User Custom Field Values For Create Ticket

  1. All the points in Common Information For Setting Ticket / User Custom Field Values.
  2. The values for user custom fields should be appended to the fields for Create Ticket.
  3. The value for a user custom fields should be sent using a field name constructed from the ID of the user custom field in the following format "c-cf-<id>".

Errors

If you specify an invalid user, you will get the error
"field": "client",
"errors": [
    "Select a valid choice. That choice is not one of the available choices."
]
                

Create new ticket using email and ID

This data structure contains information required to create a ticket. This variation uses the email and name of a user. If the email already exists in the Helpdesk, the corresponding user is used, else a new user is created.

NOTE: Any custom fields required for the ticket and user need to be appended to the list below.

Data Structure

                           

Add a Staff Update

To add a staff update make a POST request to the URL below with request data encoded in one of the supported formats. On success it returns the modified ticket.

NOTE: file attachments are supported only when using Multipart Form Data

URL <base_uri> / <response_format> /ticket/<id>/staff_update/
HTTP Method POST
Request Data Add Staff Update
Response Data Ticket

Data Structure

                           

Add a Staff Private Note

To add a staff private note make a POST request to the URL below with request data encoded in one of the supported formats. On success it returns the modified ticket.

URL<base_uri> / <response_format> /ticket/<id>/staff_pvtnote/
HTTP MethodPOST
Request DataAdd Staff Private Note
Response DataTicket

Data Structure

                           

Add a User Reply

To add a user reply make a POST request to the URL below with request data encoded in one of the supported formats. On success it returns the modified ticket.

NOTE: file attachments are supported only when using Multipart Form Data

URL<base_uri> / <response_format> /ticket/<id>/user_reply/
HTTP MethodPOST
Request DataAdd User Reply
Response DataTicket

Data Structure

                           

Search Tickets

URL<base_uri> / <response_format> /tickets/ ?q=<querystring>
HTTP MethodGET
Request Data<querystring> can be replaced with just a single search keyword, or you can use the search syntax same as the one generated by the advanced search in the HappyFox User Interface.

Example of a query string: contact:Scott(scott@example.com) priority:Normal solve

Response DataList of tickets matching the search criteria

Advanced Search Keywords

KeywordTypeDescription
idStringList of ticket ids separated by comma. eg "q=id:7095,7094"
subscribedBoolean
unrespondedBoolean
breachedBoolean
has_attachmentsBoolean
tagStringComma separated values
duedateStringAccepted values: today / yesterday / tomorrow / next 7 days / overdue (get all tickets that are overdue)
priorityStringName of priority
statusStringName of status
assigneeStringValues: none (unassigned tickets)/ any (assigned tickets)/ some keyword identifying staff like first name, last name, username, email, etc
groupStringValues: none(contact is not part of any group) / any (contact is part of a group) / name of contact group
contactStringIdentifying keyword like name of contact, email or phone number.
Custom Field namesStringFormat: "< custom field name >: < custom field value >". Eg "Address: Georgetown". You can search by contact and ticket custom fields

Data Structure

                           

Summary Information for All Tickets

URL<base_uri> / <response_format> / tickets / ?show_updates=0
HTTP MethodGET
Response DataList of tickets without any updates

Data Structure

                           

Summary Information for One Ticket

URL<base_uri> / <response_format> /ticket / <id> / ?show_updates=0
HTTP MethodGET
Response DataTicket without any updates

Data Structure