GET/desk/api/v2/customfields.json

Get a paginated list of customfields.

The following values are allowed in the filter query parameter:

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

The following values are allowed in the orderBy query parameter:

  • addToNewInboxes

  • agentLabel

  • agentRequired

  • createdAt

  • createdBy

  • customerLabel

  • customerRequired

  • deletedAt

  • deletedBy

  • description

  • displayOrder

  • enabled

  • id

  • inboxes.id

  • kind

  • state

  • tickets.id

  • updatedAt

  • updatedBy

         The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter:
     
    
  • customfieldapps

  • customfieldoptions

  • users

  • all

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": {            "additionalProp": "Unknown Type: any"          },          "type": 0        }      ],      "createdAt": "2024-12-04T16:23:03.964Z",      "createdBy": {