List all custom fields

GET
/custom-fields

Lists the company's custom fields. Each entry has the same shape as a single custom field resource: its type is one of text, textarea, select, checkbox, date, datetime, integer, or phone, and select fields expose their choices in options (each with a opt_-prefixed id); all other types return null for options.

Results are ordered by creation time, newest first, and paginated with an opaque cursor in next_cursor; pass it back as next_cursor on the next call to fetch the next page (null means there are no more results). Malformed cursors are ignored and the first page is returned.

Query Parameters

limit?integer

Number of results per page. Default 50, maximum 200. Values above 200 or zero/negative are clamped to that range rather than rejected.

Default50
next_cursor?string

Opaque pagination cursor returned in next_cursor of the previous response. Malformed values are ignored and the first page is returned.

Response Body

application/json

application/json

curl -X GET "https://example.com/custom-fields" \  -H "Easol-API-Version: 2026-11-01"
{
  "object": "string",
  "url": "string",
  "has_more": true,
  "next_cursor": "string",
  "data": [
    {
      "object": "custom_field",
      "id": "fld_aBcDeFgHiJ",
      "name": "string",
      "label": "string",
      "hint": "string",
      "type": "text",
      "entity": "guest",
      "options": [
        {
          "id": "string",
          "value": "string"
        }
      ]
    }
  ]
}
{
  "error": {
    "code": "string",
    "message": "string"
  }
}