Retrieves all Brand Boards for a specific account

http
GET https://services.leadconnectorhq.com/brand-boards/{locationId}

Authorization

NameTypeRequiredExampleDescription
AuthorizationstringYesBearer token generated from the Leadway portal. See Authentication.
VersionstringYes2021-07-28API version.

Path parameters

NameTypeRequiredExampleDescription
locationIdstringYes

Query parameters

NameTypeRequiredExampleDescription
limitnumberNo10Maximum number of brand boards to return
offsetnumberNo0Number of brand boards to skip for pagination
searchstringNobrandboardSearch term to filter brand boards by name
deletedbooleanNoFalseInclude deleted brand boards in results

Responses

200 - Success
  • brandBoards (object[], required): Array of brand boards for the account

    • _id (string, required): Brand board ID Example: 507f1f77bcf86cd799439011

    • name (string, required): Brand board name Example: My Brand Board

    • updatedAt (string, required): Last update timestamp Example: 2024-01-05T12:00:00.000Z

    • default (boolean): Whether this is the default brand board for the account Example: False

    • meta (object): Metadata about the brand board

  • totalCount (number, required): Total number of brand boards matching the query Example: 42

json
{
  "brandBoards": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "name": "My Brand Board",
      "updatedAt": "2024-01-05T12:00:00.000Z",
      "default": false
    }
  ],
  "totalCount": 42
}
400 - Bad Request
json
{}
401 - Unauthorized
json
{}
403 - The token does not have access to this account
  • statusCode (number): Example: 403

  • message (string): Example: The token does not have access to this account

json
{
  "statusCode": 403,
  "message": "The token does not have access to this account"
}
422 - Unprocessable Entity
json
{}

Example

curl -X GET 'https://services.leadconnectorhq.com/brand-boards/YOUR_locationId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

Last updated October 26, 2026

Was this page helpful?