Skip to main content
GET
Get a customer

Authorizations

Authorization
string
header
required

An organization API key (bg_live_…), created in BrandGate under Settings → Developers.

Path Parameters

id
string<uuid>
required

Response

Success.

id
string<uuid>
required
object
any
required
name
string | null
required
Maximum string length: 500
contact_name
string
required
Maximum string length: 500
email
string
required
Maximum string length: 320
phone
string | null
required
Maximum string length: 100
vat_number
string | null
required
Maximum string length: 100
status
enum<string>
required
Available options:
active,
pending,
inactive
billing_address
object
required
shipping_address
object
required
payment_terms_days
integer | null
required
preferred_currency
string | null
required
Maximum string length: 3
created_at
string<date-time>
required
updated_at
string<date-time>
required