Skip to main content
Scope: custom-fields:read Lists the business’s custom fields that are turned on, grouped by scope, in the order set in the Cleo web app. The request takes no parameters, and the list is not paged.

Response

200 with { items }. Each item is a custom field.
string
The field id.
string | null
The question.
string | null
Help text.
string
ROOT (once per bill) or INVOICE_ITEM (on each line item). INVOICE_EXPENSE, INVOICE_DEDUCTION and ATTACHMENT can also appear.
string
DROPDOWN, MULTIPLE_CHOICE, SHORT_TEXT, LONG_TEXT, DATE, NUMERIC or NUMERIC_GROUP.
boolean
Whether a bill must answer it in the Cleo web app.
array
Choices of a DROPDOWN or MULTIPLE_CHOICE field, archived ones included: id, value, label, externalId, archived, archivedAt. Empty for other types.
Fields that were turned off or deleted are left out, but bills keep their answers to them. See Old and deleted answers.

Errors