Skip to main content
GET
/
v2
/
tickets
/
{ticket_id}
/
custom-field-values
Get Ticket Custom Field Values
curl --request GET \
  --url https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values \
  --header 'Authorization: Bearer <token>'
{
  "customFields": [
    {
      "fieldValue": {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "value": 123,
        "setByUserId": "<string>",
        "setByAppInstanceId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "pinned": true
      },
      "field": {
        "id": "<string>",
        "entityTypeId": "<string>",
        "key": "<string>",
        "name": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>",
        "enumOptions": [
          {
            "id": "<string>",
            "value": "<string>",
            "displayName": "<string>",
            "displayOrder": 123
          }
        ],
        "isKeyField": true,
        "isNameField": true,
        "refEntityTypeId": "<string>",
        "description": "<string>",
        "sourceEntityTypeId": "<string>",
        "sectionId": "<string>"
      }
    }
  ],
  "deprecatedFields": [
    {
      "fieldValue": {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "value": 123,
        "setByUserId": "<string>",
        "setByAppInstanceId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z",
        "pinned": true
      },
      "field": {
        "id": "<string>",
        "entityTypeId": "<string>",
        "key": "<string>",
        "name": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>",
        "enumOptions": [
          {
            "id": "<string>",
            "value": "<string>",
            "displayName": "<string>",
            "displayOrder": 123
          }
        ],
        "isKeyField": true,
        "isNameField": true,
        "refEntityTypeId": "<string>",
        "description": "<string>",
        "sourceEntityTypeId": "<string>",
        "sectionId": "<string>"
      }
    }
  ],
  "customFieldGroups": [
    {
      "section": {
        "id": "<string>",
        "entityTypeId": "<string>",
        "name": "<string>",
        "sourceEntityTypeId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>"
      },
      "customFields": [
        {
          "fieldValue": {
            "id": "<string>",
            "entityId": "<string>",
            "fieldId": "<string>",
            "fieldKey": "<string>",
            "fieldName": "<string>",
            "value": 123,
            "setByUserId": "<string>",
            "setByAppInstanceId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "deletedAt": "2023-11-07T05:31:56Z",
            "pinned": true
          },
          "field": {
            "id": "<string>",
            "entityTypeId": "<string>",
            "key": "<string>",
            "name": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "createdByUserId": "<string>",
            "updatedByUserId": "<string>",
            "enumOptions": [
              {
                "id": "<string>",
                "value": "<string>",
                "displayName": "<string>",
                "displayOrder": 123
              }
            ],
            "isKeyField": true,
            "isNameField": true,
            "refEntityTypeId": "<string>",
            "description": "<string>",
            "sourceEntityTypeId": "<string>",
            "sectionId": "<string>"
          }
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
ticket_id
string
required

The ID of the ticket to get custom field values for.

Response

Success

Returns only the custom fields that have been explicitly set on this ticket. If no custom field values have been set yet, both lists will be empty. To discover all available custom field definitions for a team (regardless of whether values have been set), use ListCustomFieldOptions instead.

​
customFields
CustomFieldValue · object[]
​
deprecatedFields
CustomFieldValue · object[]
​
customFieldGroups
CustomFieldGroup · object[]

Active custom fields grouped by their svstore entity_field_section. Use this when rendering one container per group on the UI; the existing custom_fields list is retained for flat-list consumers.