Skip to main content
GET
Get Custom Field Definitions

Authorizations

Authorization
string
header
required

A brand-scoped or global amb_sk_... API key.

Path Parameters

brand
string
required

Brand slug authorized by this API key.

Example:

"acme"

id
string
required

Stable resource identifier.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

Visible entity.

id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
entityType
string
required
entityField
string
required
fieldKey
string
required
fieldType
string
required
label
string
required
description
string | null
required
required
boolean
required
defaultValue
any | null
required
selectValues
any[]
required
isActive
boolean
required
sequence
number
required
createdAt
string | null
required
updatedAt
string | null
required