Get a custom field definition

Retrieve a single custom field definition from the Terminal49 API, including its data type, slug, target resource type, and configured enum options.

GET /custom_field_definitions/{id}

Get a custom field definition

cURL

curl --request GET \
  --url https://api.terminal49.com/v2/custom_field_definitions/{id} \
  --header 'Authorization: <api-key>'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {
      "api_slug": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "reference_type": "<string>",
      "validation": {},
      "default_format": "<string>",
      "default_value": "<string>"
    }
  },
  "links": {
    "self": "<string>"
  }
}

Use this endpoint to retrieve a single custom field definition by its ID.

Path parameters

Parameter	Description
id	The unique identifier of the custom field definition

Authorizations

Authorization · string · header · required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Path Parameters

id · string · required

Custom field definition ID

Response

200 - application/json

OK

data · Custom field definition · object

Show child attributes

links · link · object

Show child attributes