List Custom Field Definitions

GET

/api/:account_id/custom-field-definitions/

GET

/api/:account_id/custom-field-definitions/

$ curl https://app.paymentkit.com/api/account_id/custom-field-definitions/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "items": [
3     {
4       "id": "cfd_acc_9f8b7c6d",
5       "field_key": "customer_loyalty_level",
6       "entity_type": "customer",
7       "data_type": "select",
8       "display_name": "Loyalty Level",
9       "is_visible_in_list": true,
10       "created_at": "2024-01-15T09:30:00Z",
11       "updated_at": "2024-01-15T09:30:00Z",
12       "description": "Indicates the customer's loyalty tier",
13       "constraints": {
14         "options": [
15           "Bronze",
16           "Silver",
17           "Gold",
18           "Platinum"
19         ]
20       }
21     }
22   ],
23   "total": 1,
24   "has_more": false
25 }

List all custom field definitions for the account. Returns paginated custom field definitions, optionally filtered by entity type.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Query parameters

entity_typestring or nullOptional

Filter by entity type (e.g., ‘customer’, ‘subscription’, ‘product’, ‘price’, ‘invoice’, ‘checkout_session’)

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Response

Successful Response

itemslist of objects

totalinteger

has_moreboolean

Errors

422

Unprocessable Entity Error