Skip to main content
GET
/
v0
/
brands
List brands
curl --request GET \
  --url https://api.tryarchitect.com/v0/brands \
  --header 'x-api-key: <api-key>'
{
  "hasMore": true,
  "items": [
    {
      "brandId": "brand_01j5k9m7n8p9q2r3s4t5v6w7x8",
      "companyHomePage": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "preferredAppearance": "system",
      "tenantId": "<string>",
      "themeDark": {
        "borderColor": "<string>",
        "buttonBackgroundColor": "<string>",
        "buttonTextColor": "<string>",
        "faviconFileId": "<string>",
        "faviconUrl": "<string>",
        "logoFileId": "<string>",
        "logoIconFileId": "<string>",
        "logoIconUrl": "<string>",
        "logoUrl": "<string>",
        "mutedTextColor": "<string>",
        "pageBackgroundColor": "<string>",
        "pageForegroundColor": "<string>",
        "secondaryAccentColor": "<string>",
        "sectionCardHighlightColor": "<string>"
      },
      "themeLight": {
        "borderColor": "<string>",
        "buttonBackgroundColor": "<string>",
        "buttonTextColor": "<string>",
        "faviconFileId": "<string>",
        "faviconUrl": "<string>",
        "logoFileId": "<string>",
        "logoIconFileId": "<string>",
        "logoIconUrl": "<string>",
        "logoUrl": "<string>",
        "mutedTextColor": "<string>",
        "pageBackgroundColor": "<string>",
        "pageForegroundColor": "<string>",
        "secondaryAccentColor": "<string>",
        "sectionCardHighlightColor": "<string>"
      },
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key authentication for the External Actor Gateway

Query Parameters

​
cursor
string

cursor parameter

​
limit
number

Number of page groups to return (1-100, default 20)

Response

200 - application/json

Successful operation

​
hasMore
boolean
required
​
items
object[]
required
​
nextCursor
string