Custom Fields

Custom fields allow additional data to be added to the Helpdesk as required. Custom fields can be defined for independently for users and tickets. For example, a phone number custom field can be added for users.

Read All User Custom Fields

URL <base_uri> / <response_format> /user_custom_fields/
HTTP Method GET
Response Data List of User Custom Field

Data Structure

                           

Read one user custom field

URL <base_uri> / <response_format> /user_custom_field/<id>/
HTTP Method GET
Response Data User Custom Field

Data Structure

                           

Read All Ticket Custom Fields

URL <base_uri> / <response_format> /ticket_custom_fields/
HTTP Method GET
Response Data List of Ticket Custom Field

Data Structure

                           

Read One Ticket Custom Field

URL <base_uri> / <response_format> /ticket_custom_field/<id>/
HTTP Method GET
Response Data Ticket Custom Field

Data Structure

                           

Create New Ticket Custom Field

 

URL<base_uri> / <response_format> / ticket_custom_fields/
HTTP MethodPOST
Request Data

Create ticket custom field

Response DataTicket custom field

Data Structure

                           
                           
                           
                           
                           
                           


                           

Create New User Custom Field

 

URL<base_uri> / <response_format> / user_custom_fields/
HTTP MethodPOST
Request Data

Create user custom field

Response DataUser custom field

Data Structure - JSON

                           
                           
                           
                           
                           
                           


                           

Notes

Common Information For Setting Ticket / User Custom Field Values

  1. Types of custom field: text, number, date, dropdown, multiple option
  2. The values for "depends_on" is the ID of the parent custom field and the value for "depends_on_value" is the ID of the choice in the parent custom field.