List brand voices

Page last updated 12 June 2026

Endpoint for listing the Brand Voices. This can return either Latest or Published versions.

GETapi/management/projects/{projectId}/ai/brandVoices?versionStatus={versionStatus}&pageIndex={pageIndex}&pageSize={pageSize}

Parameters

Name	Parameter type	Type	Format	Description
projectId(required)	path	string	-	The project identifier found in the project overview screen of the management console.
versionStatus	query	string	-	The status of the associated entry, either published or latest. The default is published
pageIndex	query	number	integer	The index of the page.
pageSize	query	number	integer	The number of results per page. The default is 25.

Responses

HTTP status code	Reason	Model
200	OK	Brand Voice
401	Unauthorized	Error
404	Project not found	Error
500	Internal server error	Error

Examples

HTTP

GET: /api/management/projects/website/ai/brandVoice?versionStatus=published&pageIndex=0&pageSize=10

Published only List

JSON

{
  PageIndex: 0,
  PageSize: 4,
  TotalCount: 4,
  PageCount: 1,
  Items: [
    {
      Name: Listing Brand Voice 1,
      Id: listingBrandVoice1,
      Description: Listing Brand Voice 1 - updated,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 2.0
      }
    },
    {
      Name: Listing Brand Voice 3,
      Id: listingBrandVoice3,
      Description: Listing Brand Voice 3,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 1.0
      }
    },
    {
      Name: Listing Brand Voice 5,
      Id: listingBrandVoice5,
      Description: Listing Brand Voice 5,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 1.0
      }
    },
    {
      Name: Listing Brand Voice 7,
      Id: listingBrandVoice7,
      Description: Listing Brand Voice 7,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 1.0
      }
    }
  ]
}

Latest only List

JSON

{
  PageIndex: 0,
  PageSize: 8,
  TotalCount: 8,
  PageCount: 1,
  Items: [
    {
      Name: Listing Brand Voice 1,
      Id: listingBrandVoice1,
      Description: Listing Brand Voice 1 - updated,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 2.0
      }
    },
    {
      Name: Listing Brand Voice 2,
      Id: listingBrandVoice2,
      Description: Listing Brand Voice 2,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        VersionNumber: 0.1
      }
    },
    {
      Name: Listing Brand Voice 3,
      Id: listingBrandVoice3,
      Description: Listing Brand Voice 3,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 1.0
      }
    },
    {
      Name: Listing Brand Voice 4,
      Id: listingBrandVoice4,
      Description: Listing Brand Voice 4,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        VersionNumber: 0.1
      }
    },
    {
      Name: Listing Brand Voice 5,
      Id: listingBrandVoice5,
      Description: Listing Brand Voice 5 - updated,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 1.1
      }
    },
    {
      Name: Listing Brand Voice 6,
      Id: listingBrandVoice6,
      Description: Listing Brand Voice 6,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        VersionNumber: 0.1
      }
    },
    {
      Name: Listing Brand Voice 7,
      Id: listingBrandVoice7,
      Description: Listing Brand Voice 7,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 1.0
      }
    },
    {
      Name: Listing Brand Voice 8,
      Id: listingBrandVoice8,
      Description: Listing Brand Voice 8,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        VersionNumber: 0.1
      }
    }
  ]
}

Latest and Published List

JSON

{
  PageIndex: 0,
  PageSize: 8,
  TotalCount: 8,
  PageCount: 1,
  Items: [
    {
      Name: Listing Brand Voice 1,
      Id: listingBrandVoice1,
      Description: Listing Brand Voice 1 - updated,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 2.0
      }
    },
    {
      Name: Listing Brand Voice 2,
      Id: listingBrandVoice2,
      Description: Listing Brand Voice 2,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        VersionNumber: 0.1
      }
    },
    {
      Name: Listing Brand Voice 3,
      Id: listingBrandVoice3,
      Description: Listing Brand Voice 3,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 1.0
      }
    },
    {
      Name: Listing Brand Voice 4,
      Id: listingBrandVoice4,
      Description: Listing Brand Voice 4,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        VersionNumber: 0.1
      }
    },
    {
      Name: Listing Brand Voice 5,
      Id: listingBrandVoice5,
      Description: Listing Brand Voice 5 - updated,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 1.1
      }
    },
    {
      Name: Listing Brand Voice 6,
      Id: listingBrandVoice6,
      Description: Listing Brand Voice 6,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        VersionNumber: 0.1
      }
    },
    {
      Name: Listing Brand Voice 7,
      Id: listingBrandVoice7,
      Description: Listing Brand Voice 7,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        PublishedBy: admin,
        VersionNumber: 1.0
      }
    },
    {
      Name: Listing Brand Voice 8,
      Id: listingBrandVoice8,
      Description: Listing Brand Voice 8,
      IsDefaultProjectBrandVoice: false,
      DetectedReadingEaseScore: 0,
      Inclusivity: {
        AvoidCulturalOrReligiousReferences: false,
        UseGenderNeutralNounsAndPronouns: false,
        AvoidIdiomsSlangAndAcronyms: false
      },
      Version: {
        CreatedBy: admin,
        ModifiedBy: admin,
        VersionNumber: 0.1
      }
    }
  ]
}

Remarks

You must be part of the System Administrators group or CMS Editors group.

A pageSize of -1 can be set to return all results in one call.

A versionStatus of latest or published can be passed in.

If there are no Brand Voices an empty List is returned.

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.

New support request