Skip to main content
GET
/
v2
/
teams
/
{team_id}
/
custom-field-options
List Custom Field Options
curl --request GET \
  --url https://public.api.serval.com/v2/teams/{team_id}/custom-field-options \
  --header 'Authorization: Bearer <token>'
{
  "customFields": [
    {
      "fieldValue": {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "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>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "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>"
      }
    }
  ],
  "deprecatedFields": [
    {
      "fieldValue": {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "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>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "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>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
team_id
string
required

The ID of the team to list custom field options for.

Query Parameters

​
ticketType
enum<string>

The ticket type to list custom field options for.

Available options:
TICKET_TYPE_UNSPECIFIED,
TICKET_TYPE_REQUEST,
TICKET_TYPE_TASK,
TICKET_TYPE_INCIDENT,
TICKET_TYPE_CONVERSATION,
TICKET_TYPE_JOURNEY,
TICKET_TYPE_JOURNEY_CONVERSATION

Response

Success

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