GET/desk/api/v2/customfields.json

Get a paginated list of customfields.

The following values are allowed in the filter query parameter:

  • id
  • agentLabel
  • customerLabel
  • description
  • displayOrder
  • kind
  • customerRequired
  • agentRequired
  • addToNewInboxes
  • enabled
  • createdAt
  • updatedAt
  • deletedAt
  • createdBy
  • updatedBy
  • deletedBy
  • state

The following values are allowed in the orderBy query parameter:

  • id
  • agentLabel
  • customerLabel
  • description
  • displayOrder
  • kind
  • customerRequired
  • agentRequired
  • addToNewInboxes
  • enabled
  • createdAt
  • updatedAt
  • deletedAt
  • createdBy
  • updatedBy
  • deletedBy
  • state
  • tickets.id
  • inboxes.id

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

CustomFieldsAPIBody
{  "customfields": [    {      "addToNewInboxes": true,      "agentLabel": "string",      "agentRequired": true,      "apps": [        {          "delete": true,          "id": 0,          "meta": {},          "type": 0        }      ],      "createdAt": "2024-04-12T16:21:59.318Z",      "createdBy": {        "delete": true,        "id": 0,