Get a brand voice
Log in to add to favouritesPage last updated 12 June 2026
Endpoint for retrieving a Brand Voice. By default we always return the latest version if no versionStatus parameter is passed in the call.
GETapi/management/projects/{projectId}/ai/brandvoices/{brandVoiceId}?versionStatus={versionStatus}
Parameters
| Name | Parameter type | Type | Description |
|---|---|---|---|
| projectId(required) | path | string | The project identifier found in the project overview screen of the management console. |
| brandVoiceId(required) | path | string | The brand voice string Id |
| versionStatus | query | string | The status of the associated entry, either published or latest. The default is published |
Responses
| HTTP status code | Reason | Model |
|---|---|---|
| 200 | OK | Brand Voice |
| 401 | Unauthorized | Error |
| 404 | Not Found | Error |
| 404 | Project not found | Error |
| 500 | Internal server error | Error |
Examples
GET: /api/management/projects/website/ai/brandvoice/brand-voice-id?versionStatus=published{
"name": "Contensis: Event",
"id": "contensis-event",
"description": "Contensis event brand voice to help keep it consistent",
"training": {
"text": "Text to train the model and generate a customized brand voice",
"urls": [
"https://www.contensis.com/community/blog/content-personalisation-101-what-it-is-why-it-matters-and-how-to-do-it-well"
]
},
"isDefaultProjectBrandVoice": false,
"summary": "The brand voice is approachable yet knowledgeable, blending clarity with helpful authority to guide readers through complex content personalisation concepts in an encouraging and pragmatic way.",
"tone": "conversational and informative",
"personalityTraits": "friendly, supportive, knowledgeable, practical",
"languageComplexity": "simple to intermediate",
"sentenceStructure": "short to medium-length, clear and direct",
"vocabularyChoices": "industry terminology explained clearly, approachable phrasing",
"useOfLiteraryDevices": "occasional rhetorical questions, direct address (\"you\"), analogies, gentle reassurance",
"uniqueCharacteristics": "breaks down complex ideas into manageable steps; reassures and motivates the reader; uses inclusive language to demystify digital concepts",
"detectedReadingEaseScore": 38,
"readingEaseOverride": "Difficult",
"inclusivity": {
"avoidCulturalOrReligiousReferences": true,
"useGenderNeutralNounsAndPronouns": true,
"avoidIdiomsSlangAndAcronyms": true
},
"termsToAvoid": "synergy",
"version": {
"createdBy": "zengenti",
"created": "2025-08-26T07:36:29.4079731Z",
"versionNo": "0.1",
"modified": "2025-08-26T07:46:19.8670205Z",
"modifiedBy": "zengenti",
"published": "2025-08-26T07:46:20.9374212Z",
"publishedBy": "zengenti"
}
}Remarks
You must be part of the System Administrators group or CMS Editors group.