v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Custom Fields

List custom fields

List and filter custom fields.

get/custom_fields

Query parameters

limitinteger

starting_afterstring uuid

The ID of the object from which your list request will start. It is not included in the result.

sort_order'asc' | 'desc'

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

start_datestring date

The creation date of the custom field.

end_datestring date

The creation date of the custom field.

keystring

The key of the custom field.

object_typestring[]

The types of object the custom field can be applied to.

type'select' | 'text'

The type of the custom field.

Response

200

Example response

{
  "records": [
    {
      "key": "customer_country",
      "name": "Customer country",
      "type": "select",
      "object_types": [
        "payment_order",
        "external_account"
      ],
      "values": [
        {
          "key": "fr",
          "name": "France"
        },
        {
          "key": "uk",
          "name": "United-Kingdom"
        }
      ],
      "created_at": "2024-01-03T11:53:19.734182Z"
    }
  ]
}