Form Fields

GET/api/v1/tickets/fields

This endpoint allows you to retrieve a paginated list of custom fields available for tickets.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Responses

200

pageintegerrequired
pageSizeintegerrequired
totalintegerrequired
lastPageintegerrequired
dataarray[object]required
Child attributes
- idstringoptional
- createdAtstringoptional
- updatedAtstringoptional
- deletedAtnulloptional
- systemNamestringoptional
- displayNamestringoptional
- typestringoptional
- positionintegeroptional
- isDefaultbooleanoptional
- isArchivedbooleanoptional
- isRequiredbooleanoptional
- isUniquebooleanoptional
- groupIdstringoptional

Request

curl -X GET "https://apigw.klinkcx.com/api/v1/tickets/fields" \
  -H "Authorization: Bearer {token}"

Response

{
  "page": 1,
  "pageSize": 10,
  "total": 25,
  "lastPage": 3,
  "data": [
    {
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": null,
      "systemName": "string",
      "displayName": "string",
      "type": "string",
      "position": 1,
      "isDefault": true,
      "isArchived": false,
      "isRequired": true,
      "isUnique": true,
      "groupId": "string"
    }
  ]
}