Skip to main content
GET
List custom fields
Filter by status, type, location, slugs, ids, required or a case-insensitive label match. Deactivated definitions are included unless you filter on status. A list filter takes its values comma-separated (?type=SELECT,TEXT); repeating the parameter (?type=SELECT&type=TEXT) works too.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of your organization.

Format: UUID

Query Parameters

ids
string[]

Only the fields with these IDs.


Example (comma-separated list): ?ids=9c4f0a2e-7b3d-4e8a-a1f5-2d6c8b0e4a71,29bfc458-6d62-4e37-9a89-dc620926bae5

Maximum array length: 500
slugs
string[]

Only the fields with these slugs (exact match).


Example (comma-separated list): ?slugs=centro-de-custo,projeto

Maximum array length: 500
status
enum<string>

Only fields in this status. Omit to list active and deactivated fields alike.

Available options:
ACTIVE,
DEACTIVATED
type
enum<string>[]

Only fields of these value types.


Example (comma-separated list): ?type=SELECT,TEXT

Available options:
TEXT,
NUMBER,
DATE,
BOOLEAN,
SELECT,
MULTI_SELECT,
CUSTOMER,
FILE,
MULTI_FILE
location
enum<string>[]

Only fields attached to at least one of these entities.


Example (comma-separated list): ?location=TRANSACTION,CARD

Available options:
TRANSACTION,
CARD,
WALLET,
CUSTOMER,
TRIP,
TRAVEL_PASSENGER,
USER,
VEHICLE
label
string

Only fields whose label contains this text (case-insensitive).

Maximum string length: 200
required
boolean

Only required (true) or optional (false) fields.

limit
integer

Page size, 1–100. Defaults to 15.

Required range: 1 <= x <= 100
next
string

Cursor returned as next by the previous page. Omit for the first page.

order
enum<string>

Sort direction (case-insensitive). Applied only together with orderBy.

Available options:
ASC,
DESC
orderBy
enum<string>

Field to sort by, applied only together with order. Omitted: newest first. Prefer slug (unique) over label for an alphabetical order: pages may repeat rows when several fields share the same label.

Available options:
createdAt,
updatedAt,
label,
slug

Response

Successful response

One page of custom-field definitions.

items
object[]
required

The definitions on this page, newest first unless orderBy was given.

next
string | null
required

Opaque cursor of the next page — pass it as the next query parameter. null on the last page.

Example:

"NjhkM2YxYTJjNGI1ZTZmN2E4YjljMGQx"