Skip to main content
GET
Get custom field definitions

Authorizations

Authorization
string
header
required

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

Query Parameters

includeArchived
boolean

Include archived definitions. Defaults to false.

Response

200 - application/json
id
string
required
organizationId
string
required
entityType
enum<string>
required
Available options:
INVOICE,
AR_INVOICE,
COUNTERPARTY
key
string
required
label
string
required
type
enum<string>
required
Available options:
NUMBER,
STRING,
SELECT,
MULTI_SELECT,
CHECKBOX
options
array
required
sortOrder
number
required
description
string | null
archivedAt
object | null