Brand VoicesVersion: v3New

List Brand Voices

GET/brand-boards/locations/{locationId}/brand-voices

Get list of brand voices for a location

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:brand-boards/voices.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

locationIdstringrequired

Location ID

Example:oHJiAh0wDG3BzmzACVD6

Query Parameters

limitnumber

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

Possible values: >= 1 and <= 20

Default:10

Example:10

offsetnumber

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

Possible values: >= 0

Default:0

Example:0

searchstring

Search text for brand voice name

Example:My Brand Voice

deletedboolean

Whether to return deleted brand voices. Defaults to false

Default:false

Example:false

Response

application/json

Success

itemsobject[]required

List of brand voices

totalnumberrequired

Total count of brand voices

Example:25

traceIdstring

Trace ID of request

Example:019e4ef5-a65e-4198-8cf9-8e93dca9bda4