Get Ticket Custom Field Values - Serval Documentation

GET

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>'

import requests

url = "https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "customFields": [
    {
      "fieldValue": {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "value": 123,
        "setByUserId": "<string>",
        "setByAppInstanceId": "<string>",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "deletedAt": "2025-01-15T01:30:15.000Z",
        "pinned": true,
        "redacted": true,
        "sensitive": true
      },
      "field": {
        "id": "<string>",
        "entityTypeId": "<string>",
        "key": "<string>",
        "name": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "updatedAt": "2025-01-15T01:30:15.000Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>",
        "enumOptions": [
          {
            "id": "<string>",
            "value": "<string>",
            "displayName": "<string>",
            "displayOrder": 123,
            "description": "<string>"
          }
        ],
        "isKeyField": true,
        "isNameField": true,
        "fieldId": "<string>",
        "refEntityTypeId": "<string>",
        "refEntityTypeIds": [
          "<string>"
        ],
        "description": "<string>",
        "sourceEntityTypeId": "<string>",
        "viewerCanViewValues": true,
        "viewerCanEdit": true,
        "helpAgentVisible": true,
        "sensitive": true,
        "sectionId": "<string>",
        "displayOptions": {
          "boolean": {
            "style": "STYLE_UNSPECIFIED"
          }
        }
      },
      "hidden": true
    }
  ],
  "deprecatedFields": [
    {
      "fieldValue": {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "value": 123,
        "setByUserId": "<string>",
        "setByAppInstanceId": "<string>",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "deletedAt": "2025-01-15T01:30:15.000Z",
        "pinned": true,
        "redacted": true,
        "sensitive": true
      },
      "field": {
        "id": "<string>",
        "entityTypeId": "<string>",
        "key": "<string>",
        "name": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "updatedAt": "2025-01-15T01:30:15.000Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>",
        "enumOptions": [
          {
            "id": "<string>",
            "value": "<string>",
            "displayName": "<string>",
            "displayOrder": 123,
            "description": "<string>"
          }
        ],
        "isKeyField": true,
        "isNameField": true,
        "fieldId": "<string>",
        "refEntityTypeId": "<string>",
        "refEntityTypeIds": [
          "<string>"
        ],
        "description": "<string>",
        "sourceEntityTypeId": "<string>",
        "viewerCanViewValues": true,
        "viewerCanEdit": true,
        "helpAgentVisible": true,
        "sensitive": true,
        "sectionId": "<string>",
        "displayOptions": {
          "boolean": {
            "style": "STYLE_UNSPECIFIED"
          }
        }
      },
      "hidden": true
    }
  ],
  "customFieldGroups": [
    {
      "section": {
        "id": "<string>",
        "entityTypeId": "<string>",
        "name": "<string>",
        "sourceEntityTypeId": "<string>",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "updatedAt": "2025-01-15T01:30:15.000Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>"
      },
      "customFields": [
        {
          "fieldValue": {
            "id": "<string>",
            "entityId": "<string>",
            "fieldId": "<string>",
            "fieldKey": "<string>",
            "fieldName": "<string>",
            "dataType": "DATA_TYPE_UNSPECIFIED",
            "value": 123,
            "setByUserId": "<string>",
            "setByAppInstanceId": "<string>",
            "createdAt": "2025-01-15T01:30:15.000Z",
            "deletedAt": "2025-01-15T01:30:15.000Z",
            "pinned": true,
            "redacted": true,
            "sensitive": true
          },
          "field": {
            "id": "<string>",
            "entityTypeId": "<string>",
            "key": "<string>",
            "name": "<string>",
            "dataType": "DATA_TYPE_UNSPECIFIED",
            "createdAt": "2025-01-15T01:30:15.000Z",
            "updatedAt": "2025-01-15T01:30:15.000Z",
            "createdByUserId": "<string>",
            "updatedByUserId": "<string>",
            "enumOptions": [
              {
                "id": "<string>",
                "value": "<string>",
                "displayName": "<string>",
                "displayOrder": 123,
                "description": "<string>"
              }
            ],
            "isKeyField": true,
            "isNameField": true,
            "fieldId": "<string>",
            "refEntityTypeId": "<string>",
            "refEntityTypeIds": [
              "<string>"
            ],
            "description": "<string>",
            "sourceEntityTypeId": "<string>",
            "viewerCanViewValues": true,
            "viewerCanEdit": true,
            "helpAgentVisible": true,
            "sensitive": true,
            "sectionId": "<string>",
            "displayOptions": {
              "boolean": {
                "style": "STYLE_UNSPECIFIED"
              }
            }
          },
          "hidden": true
        }
      ]
    }
  ]
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	`tickets:read`
Team-scoped API key	`tickets:read`
User-based token (OAuth)	Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

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

200 - application/json

Success

Returns the ticket's custom-field schema for its (type, subtype) model, with current values where set. Unset fields still appear (field_value empty). When no values have ever been written the schema is still returned — resolved from the ticket row, same as the UI's GetCustomFieldOptionsForTicketType path.

customFields

CustomFieldValue · object[]

Show child attributes

deprecatedFields

CustomFieldValue · object[]

Show child attributes

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.

Show child attributes

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>'

import requests

url = "https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/tickets/{ticket_id}/custom-field-values")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "customFields": [
    {
      "fieldValue": {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "value": 123,
        "setByUserId": "<string>",
        "setByAppInstanceId": "<string>",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "deletedAt": "2025-01-15T01:30:15.000Z",
        "pinned": true,
        "redacted": true,
        "sensitive": true
      },
      "field": {
        "id": "<string>",
        "entityTypeId": "<string>",
        "key": "<string>",
        "name": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "updatedAt": "2025-01-15T01:30:15.000Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>",
        "enumOptions": [
          {
            "id": "<string>",
            "value": "<string>",
            "displayName": "<string>",
            "displayOrder": 123,
            "description": "<string>"
          }
        ],
        "isKeyField": true,
        "isNameField": true,
        "fieldId": "<string>",
        "refEntityTypeId": "<string>",
        "refEntityTypeIds": [
          "<string>"
        ],
        "description": "<string>",
        "sourceEntityTypeId": "<string>",
        "viewerCanViewValues": true,
        "viewerCanEdit": true,
        "helpAgentVisible": true,
        "sensitive": true,
        "sectionId": "<string>",
        "displayOptions": {
          "boolean": {
            "style": "STYLE_UNSPECIFIED"
          }
        }
      },
      "hidden": true
    }
  ],
  "deprecatedFields": [
    {
      "fieldValue": {
        "id": "<string>",
        "entityId": "<string>",
        "fieldId": "<string>",
        "fieldKey": "<string>",
        "fieldName": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "value": 123,
        "setByUserId": "<string>",
        "setByAppInstanceId": "<string>",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "deletedAt": "2025-01-15T01:30:15.000Z",
        "pinned": true,
        "redacted": true,
        "sensitive": true
      },
      "field": {
        "id": "<string>",
        "entityTypeId": "<string>",
        "key": "<string>",
        "name": "<string>",
        "dataType": "DATA_TYPE_UNSPECIFIED",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "updatedAt": "2025-01-15T01:30:15.000Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>",
        "enumOptions": [
          {
            "id": "<string>",
            "value": "<string>",
            "displayName": "<string>",
            "displayOrder": 123,
            "description": "<string>"
          }
        ],
        "isKeyField": true,
        "isNameField": true,
        "fieldId": "<string>",
        "refEntityTypeId": "<string>",
        "refEntityTypeIds": [
          "<string>"
        ],
        "description": "<string>",
        "sourceEntityTypeId": "<string>",
        "viewerCanViewValues": true,
        "viewerCanEdit": true,
        "helpAgentVisible": true,
        "sensitive": true,
        "sectionId": "<string>",
        "displayOptions": {
          "boolean": {
            "style": "STYLE_UNSPECIFIED"
          }
        }
      },
      "hidden": true
    }
  ],
  "customFieldGroups": [
    {
      "section": {
        "id": "<string>",
        "entityTypeId": "<string>",
        "name": "<string>",
        "sourceEntityTypeId": "<string>",
        "createdAt": "2025-01-15T01:30:15.000Z",
        "updatedAt": "2025-01-15T01:30:15.000Z",
        "createdByUserId": "<string>",
        "updatedByUserId": "<string>"
      },
      "customFields": [
        {
          "fieldValue": {
            "id": "<string>",
            "entityId": "<string>",
            "fieldId": "<string>",
            "fieldKey": "<string>",
            "fieldName": "<string>",
            "dataType": "DATA_TYPE_UNSPECIFIED",
            "value": 123,
            "setByUserId": "<string>",
            "setByAppInstanceId": "<string>",
            "createdAt": "2025-01-15T01:30:15.000Z",
            "deletedAt": "2025-01-15T01:30:15.000Z",
            "pinned": true,
            "redacted": true,
            "sensitive": true
          },
          "field": {
            "id": "<string>",
            "entityTypeId": "<string>",
            "key": "<string>",
            "name": "<string>",
            "dataType": "DATA_TYPE_UNSPECIFIED",
            "createdAt": "2025-01-15T01:30:15.000Z",
            "updatedAt": "2025-01-15T01:30:15.000Z",
            "createdByUserId": "<string>",
            "updatedByUserId": "<string>",
            "enumOptions": [
              {
                "id": "<string>",
                "value": "<string>",
                "displayName": "<string>",
                "displayOrder": 123,
                "description": "<string>"
              }
            ],
            "isKeyField": true,
            "isNameField": true,
            "fieldId": "<string>",
            "refEntityTypeId": "<string>",
            "refEntityTypeIds": [
              "<string>"
            ],
            "description": "<string>",
            "sourceEntityTypeId": "<string>",
            "viewerCanViewValues": true,
            "viewerCanEdit": true,
            "helpAgentVisible": true,
            "sensitive": true,
            "sectionId": "<string>",
            "displayOptions": {
              "boolean": {
                "style": "STYLE_UNSPECIFIED"
              }
            }
          },
          "hidden": true
        }
      ]
    }
  ]
}

​Authentication and permissions

Authorizations

Path Parameters

Response

Authentication and permissions