Get Brand Board

GET 
/brand-boards/:locationId/:id

Retrieves a specific Brand Board by its ID

Request

Version stringrequired

API Version

Available options2021-04-15

locationId stringrequired

Location ID where the brand board exists

id stringrequired

Brand board ID to update, retrieve, or delete

application/json

Success

application/json

Schema

Schema

_idstringrequired

Brand board ID

locationIdstringrequired

Location ID

namestringrequired

Brand board name

logosobject[]

Array of logos

colorsobject[]

Array of brand colors

fontsobject[]

Array of brand fonts

defaultbooleanrequired

Whether this is the default brand board for the location

deletedbooleanrequired

Whether the brand board has been soft deleted

parentIdstring

Parent folder ID in media library

folderIdstring

Media library folder ID for this brand board

originIdstring

Original brand board ID if cloned from snapshot

metaobject

Metadata about the brand board

missingAssetsobject

Assets that used fallbacks/defaults (only returned when creating from URL)

createdAtstring

Creation timestamp

updatedAtstring

Last update timestamp

Example (auto)

{
  "_id": "507f1f77bcf86cd799439011",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "name": "My Brand Board",
  "logos": [
    {
      "url": "https://storage.googleapis.com/bucket/logos/my-logo.png",
      "label": "Primary Logo",
      "path": "/locations/ve9EPM428h8vShlRW1KT/logos/my-logo.png"
    }
  ],
  "colors": [
    {
      "hexa": "#FF5733FF",
      "rgba": "rgba(255, 87, 51, 1)",
      "hex": "#FF5733",
      "rgb": "rgb(255, 87, 51)",
      "label": "Brand Orange"
    }
  ],
  "fonts": [
    {
      "font": "Montserrat",
      "fallback": "sans-serif",
      "label": "Heading Font"
    }
  ],
  "default": false,
  "deleted": false,
  "parentId": "507f1f77bcf86cd799439011",
  "folderId": "507f1f77bcf86cd799439011",
  "originId": "507f1f77bcf86cd799439011",
  "meta": {
    "updatedBy": "user_abc123",
    "lastAction": "UPDATE",
    "sourceId": "507f1f77bcf86cd799439011",
    "sourceType": "blank"
  },
  "missingAssets": {
    "logos": [
      "Footer"
    ],
    "fonts": [
      "Arial"
    ],
    "colors": []
  },
  "createdAt": "2024-01-05T12:00:00.000Z",
  "updatedAt": "2024-01-05T12:00:00.000Z"
}