List custom fields

Lists your reusable custom-field definitions, cursor-paginated, with live usage bookkeeping on every row: usage_count and cards_using[] show exactly which card templates reference each field - the numbers that decide which edits are allowed (renames, type changes, and option removals are blocked while a field is in use). Scope: custom_fields:read.

Filter by field_type.

GET /v1/custom_fields

List custom fields

cURL

curl --request GET \
  --url https://api.vexioncards.one/v1/custom_fields \
  --header 'Authorization: Bearer <token>'

200

Fields

{ "object": "list", "data": [ { "id": "cf_01HW9R9Z4EF7N8MTX1RVCFLD01", "object": "custom_field", "key": "department", "description": "Clinic department the patient is assigned to.", "field_type": "select", "position": 2, "options": [ { "value": "cardio", "label": "Cardiology" }, { "value": "neuro", "label": "Neurology" }, { "value": "ortho", "label": "Orthopedics" } ], "date_granularity": "date", "usage_count": 3, "cards_using": [ "crd_l47u555jitul2m63lryijy4wya", "crd_eyua5rb6gzr3jtydy3fgbhcgpy", "crd_pkmywxjb63cng2aupvzyymxuzm" ], "created_at": 1750000000, "updated_at": 1750000000, "label": { "sk": "Oddelenie", "en": "Department" } } ], "has_more": false, "url": "/v1/custom_fields" }

Authorizations

Authorization · string · header · required

Your secret API key as a Bearer token: Authorization: Bearer vxn_sk_.... Keys are created and scoped in the dashboard - see Authentication.

Query Parameters

limit · integer · default: 25

Page size, 1-100. Default 25.

Required range: 1 <= x <= 100

starting_after · string

Cursor: object id from the previous page (forward walk). Numeric offset or page parameters are not supported; cursors are the only supported paging mechanism.

ending_before · string

Cursor: object id from the previous page (reverse walk).

field_type · enum<string>

Filter by field type (the 8-type registry - see the Custom Field object).

Available options: text, textarea, number, currency, date, boolean, select, multiselect

Response

200

application/json

Paginated custom field list.

Standard cursor-pagination envelope for list endpoints. See the Pagination guide.

object · string · required

Always "list".

Allowed value: "list"

data · object[] · required

Array of the requested resource type.

Show child attributes

has_more · boolean · required

True when more pages exist - pass the last item id as starting_after.

next_cursor · string | null

Cursor for the next page in the direction you are already paging, or null when this page ends the collection. has_more: true always comes with a non-null next_cursor.

Feed it back to the SAME parameter you used: starting_after when paging forward (the default), or ending_before when paging backward. Treat it as opaque and do not parse it.

You no longer need to take the last object's id yourself. That still works and is unchanged, but deriving the cursor from the page put the burden of knowing the sort direction on you, and it broke silently on any endpoint whose cursor is not the object id.

Example:

"cus_iofv5j4hn6bphinmmyat27tc5y"

url · string

Stable collection URL.

Allowed value: "/v1/custom_fields"