Get Brand Boards

GET 
/brand-boards/:locationId

Retrieves all Brand Boards for a specific location

Request

Version stringrequired

API Version

Available options2021-04-15

locationId stringrequired

Location ID where the brand boards exist

limit number

Maximum number of brand boards to return

Default value:10

offset number

Number of brand boards to skip for pagination

Default value:0

search string

Search term to filter brand boards by name

Default value:

deleted boolean

Include deleted brand boards in results

Default value:false

application/json

Success

application/json

Schema

Schema

brandBoardsobject[]required

Array of brand boards for the location

totalCountnumberrequired

Total number of brand boards matching the query

Example (auto)

{
  "brandBoards": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "name": "My Brand Board",
      "updatedAt": "2024-01-05T12:00:00.000Z",
      "default": true,
      "meta": {
        "updatedBy": "user_abc123",
        "lastAction": "UPDATE",
        "sourceType": "blank"
      }
    }
  ],
  "totalCount": 42
}