Skip to main content
GET
/
v1
/
brand
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/brand \
  --header 'Authorization: Bearer <token>'
{
  "id": "4cd29336-3cc7-4da9-9bef-b41c59416681",
  "object": "brand",
  "color": "000000",
  "email": null,
  "theme": "light",
  "phone": null,
  "powered_by_enabled": true,
  "website": null,
  "address": null,
  "logo": null,
  "dark_logo": null,
  "created_at": 1771429850,
  "updated_at": 1771429850
}

Authorizations

​
Authorization
string
header
required

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

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
color
string | null

The primary brand color. Used for buttons, links, loading states, etc.

​
email
string | null

The email address that will be shown to customers for support, on statements, etc.

​
phone
string | null

The phone number that will be shown to customers for support, on statements, etc.

​
theme
string

The color theme for all store branded pages (i.e. affiliate portal). One of light or dark.

​
website
string | null

The website that will be shown to customers for support, on statements, etc.

​
dark_logo

Expandable – The associated media ID.

​
logo

Expandable – The associated media ID.

​
address

Expandable – The associated address ID.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.