Skip to main content
GET
/
api
/
v2
/
brand-voice
/
list
List Brand Voices
curl --request GET \
  --url https://app.octavehq.com/api/v2/brand-voice/list \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": {
    "hasNext": false,
    "total": 0,
    "data": [
      {
        "oId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "name": "<string>",
        "deletedAt": "<string>",
        "data": {
          "title": "<string>",
          "description": "<string>",
          "personality": {
            "coreTraits": [
              "<string>"
            ],
            "guidingPrinciples": [
              "<string>"
            ]
          },
          "tonality": {
            "soundLike": [
              "<string>"
            ],
            "neverSoundLike": [
              "<string>"
            ]
          },
          "vocabulary": {
            "keyCompanyTerms": [
              "<string>"
            ],
            "keySubstitutions": [
              "<string>"
            ]
          },
          "writingRules": {
            "languageRules": [
              "<string>"
            ],
            "formattingFundamentals": [
              "<string>"
            ]
          },
          "audienceConsiderations": {
            "qualitiesAndCharacteristics": [
              "<string>"
            ],
            "aspirationsAndBoundaries": [
              "<string>"
            ]
          },
          "essence": "<string>",
          "customFields": [
            {
              "title": "<string>",
              "value": [
                "<string>"
              ]
            }
          ]
        },
        "default": false,
        "user": {
          "oId": "<string>",
          "firstName": "<string>",
          "lastName": "<string>"
        },
        "workspace": {
          "oId": "<string>"
        }
      }
    ]
  }
}

Authorizations

api_key
string
header
required

Query Parameters

limit
number | null
default:10

Maximum number of results to return

offset
number | null
default:0

Number of results to skip

Response

List of brand voices

_metadata
object
required
data
object
required