Skip to main content
GET
/
v2
/
custom-fields
/
{id}
Get a custom field definition by ID
curl --request GET \
  --url https://api.carecycle.ai/v2/custom-fields/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recordType": "customers",
  "fieldKey": "<string>",
  "fieldLabel": "<string>",
  "fieldDescription": "<string>",
  "fieldType": "text",
  "isRequired": true,
  "options": [
    "<string>"
  ],
  "validationRules": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

Path Parameters

​
id
string<uuid>
required

Custom field definition ID

Response

GET /v2/custom-fields/:id Positive response

Custom field definition with all metadata

​
id
string<uuid>
required
​
createdAt
string | null
required
​
updatedAt
string | null
required
​
clientId
string<uuid>
required
​
recordType
enum<string>
required
Available options:
customers
​
fieldKey
string
required

Generated identifier for the field

Maximum string length: 100
​
fieldLabel
string
required

Display name shown to users

Maximum string length: 255
​
fieldDescription
string
required

Description of the field's purpose

​
fieldType
enum<string>
required

Type of data this field stores

Available options:
text,
number,
boolean,
date,
select,
multi_select
​
isRequired
boolean | null
required

Whether this field must have a value

​
options
string[] | null
required

Available options for select/multi-select fields

​
validationRules
required

Validation rules for the custom field