List Brand Voices

GET 
/brand-boards/public/v1/locations/:locationId/voices

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Get list of brand voices for a location

Request

Version stringrequired

API Version

Available options2023-02-21

locationId stringrequired

Location ID

limit number

Number of brand voices to return. Defaults to 10, minimum is 1, maximum is 20

Possible values: >= 1 and <= 20

Default value:10

offset number

Number of brand voices to skip for pagination. Defaults to 0, minimum is 0

Possible values: >= 0

Default value:0

search string

Search text for brand voice name

deleted boolean

Whether to return deleted brand voices. Defaults to false

Default value:false

application/json

Success

application/json

Schema

Schema

itemsobject[]required

List of brand voices

totalnumberrequired

Total count of brand voices

traceIdstring

Trace ID of request

Example (auto)

{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "My Brand Voice",
      "isDefault": false,
      "createdAt": "2024-01-05T12:00:00.000Z",
      "updatedAt": "2024-01-05T12:00:00.000Z"
    }
  ],
  "total": 25,
  "traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}