Brands

Get a brand

GET/v1/brands/{brandId}

Get one brand with its domains, theme and effective tracking settings.

curl "$AYEFORM_API/v1/brands/$BRAND_ID" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

{
  "id": "j3tgery5gg5v83s7yc8t0hdzsrmggfz2",
  "name": "Luigi's Pizza",
  "domains": [
    "luigispizza.com"
  ],
  "avatarUrl": "https://luigispizza.com",
  "theme": {
    "accent": "…",
    "accentText": "…",
    "background": "…",
    "surface": "…",
    "text": "…",
    "muted": "…",
    "border": "…",
    "radius": 0,
    "buttonRadius": 0,
    "font": "…",
    "headingFont": "…",
    "backdrop": "…",
    "fontStylesheet": "…"
  },
  "tracking": {
    "meta": {
      "enabled": false,
      "pixelId": "q7922110v3afpg44cwsvh9avpm3q9xwy",
      "pageView": false,
      "capi": false
    },
    "ga4": {
      "enabled": false,
      "measurementId": "f7211h7pjrx06231gqk7sbx4qbwftzq0"
    },
    "jornaya": {
      "enabled": false,
      "campaignKey": "…"
    },
    "trustedForm": {
      "enabled": false
    }
  },
  "hasMetaCapiToken": true,
  "webhookCount": -9007199254740991,
  "starter": false,
  "createdAt": 1790879400000,
  "workspaceId": "q9vxefwe62t8njyxv1pjr1vdq9s1awap"
}

Path parameters

brandIdstringrequired
The brand's id.

Response

idstringrequired
The brand's id.
namestringrequired
The brand's name.
domainsarray of stringrequired
Hostnames the brand's forms may be embedded on. Subdomains match too. An empty list means any site.
avatarUrlstring or nullrequired
The brand's favicon, fetched in the background from its first public domain. It is fetched again when the first public domain changes. Null until there is one, so show initials instead.
themeobjectrequired
The theme values the brand sets. The rest use the defaults.
Show 13 fieldsHide 13 fields
- accentstring
- accentTextstring
- backgroundstring
- surfacestring
- textstring
- mutedstring
- borderstring
- radiusnumber
  0–48
- buttonRadiusnumber
  0–48
- fontstring
- headingFontstring
  max 500 chars
- backdropstring
- fontStylesheetstring
  max 2000 chars · uri
trackingobjectrequired
The tracking settings in effect, which are the brand's values on top of the defaults.
Show 4 fieldsHide 4 fields
- metaobjectrequired
  Show 4 fieldsHide 4 fields
  enabledbooleanrequired
  pageViewbooleanrequired
  capibooleanrequired
  pixelIdstring
- ga4objectrequired
  Show 2 fieldsHide 2 fields
  enabledbooleanrequired
  measurementIdstring
- jornayaobjectrequired
  Show 2 fieldsHide 2 fields
  enabledbooleanrequired
  campaignKeystring
- trustedFormobjectrequired
  Show 1 fieldHide 1 field
  enabledbooleanrequired
hasMetaCapiTokenbooleanrequired
Whether a Meta Conversions API token is saved. The token itself is never returned.
webhookCountintegerrequired
How many webhooks the brand has, its own and its forms', counted up to 100. GET /v1/webhooks lists them.
-9007199254740991–9007199254740991
starterbooleanrequired
True for a guest's starter brand, which has no website or name yet. False for every other brand.
createdAtnumberrequired
When the brand was made, in milliseconds since the epoch.
workspaceIdstringrequired
The workspace the brand belongs to.

Errors answer with a status and the error shape.