Skip to main content
GET
/
v2
/
custom-fields
Get paginated list of custom field definitions fo…
curl --request GET \
  --url https://api.carecycle.ai/v2/custom-fields \
  --header 'x-api-key: <api-key>'
{
  "itemsTotal": 123,
  "currentPage": 123,
  "nextPage": 123,
  "prevPage": 123,
  "items": [
    {
      "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.

Query Parameters

​
page
number
default:1

GET /v2/custom-fields Parameter

Required range: x >= 1
​
perPage
number
default:50

GET /v2/custom-fields Parameter

Required range: 1 <= x <= 100
​
recordType
enum<string>

Filter by record type

Available options:
customers
​
sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
fieldLabel,
fieldType
​
sortDirection
enum<string>
default:desc

Sort direction

Available options:
asc,
desc

Response

GET /v2/custom-fields Positive response

​
itemsTotal
number
required
​
currentPage
number
required
​
nextPage
number | null
required
​
prevPage
number | null
required
​
items
object[]
required

List of custom field definitions