List brand kit sections

Request

Retrieves a list of sections in a brand kit. Each section contains information that define the brand's identity and guidelines, such as Brand Context, Global Goals, and Tone of Voice.

To return actual content in the sections, the Documents REST API and Pipeline REST API must have already been used to upload and process brand documents for the brand kit.

Security

HTTPBearer

Path

organizationIdstring(Organizationid)required

The unique identifier of your organization.

To get this value, in the Sitecore Cloud Portal URL, the organizationId comes after organization= .

Example:org_ABCDef123456

brandkitIdstring(Brandkitid)required

The unique identifier of your brand kit.

To get this value, use the List brand kits endpoint to return the id of each brand kit in your organization. This is the same id returned when you create a brand kit using the Create a brand kit endpoint.

Alternatively, you can open your brand kit in Stream. In the Sitecore Cloud Portal URL, brandkitId comes after brandkits/.

Example:d2c2df7a-1137-43dd-bba3-73ec313526b1

Query

sectionIdsArray of strings or null(Sectionids)

Example:sectionIds=sectionId1&sectionIds=sectionId2

Any of:

An array of section IDs to filter the results. If not provided, all sections in the brand kit are returned.

Array of strings

includeDeletedboolean or null(Includedeleted)

Example:includeDeleted=false

Any of:

Whether to include deleted sections in the response.

boolean

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/ai/ai-brands-api/api/brands/v1/organizations/org_ABCDef123456/brandkits/d2c2df7a-1137-43dd-bba3-73ec313526b1/sections?sectionIds=sectionId1%2CsectionId2&includeDeleted=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Brand kit sections retrieved successfully

Bodyapplication/json

Array [

idstring(Id)required

The unique identifier of the brand kit section.

Example:"37a49437-e1c8-4697-b1c2-914e2382ea75"

namestring(Name)required

The name of the brand kit section.

Example:"Brand Context"

deletableboolean or null(Deletable)

Example:true

Any of:

Whether the section can be deleted.

boolean

orderinteger or null(Order)

Example:2

Any of:

The position of the section within the brand kit. For example, if Global Goals is the first section, its order is 1. If Brand Context is second, order is 2, and so on.

integer

createdOnstring or null(Createdon)

Example:"2025-06-18T12:46:12.718310Z"

Any of:

The date and time when the section was created, formatted in ISO 8601.

string (date-time)

createdBystring or null(Createdby)

Example:"mman"

Any of:

The user who created the section.

string

updatedOnstring or null(Updatedon)

Example:"2025-06-18T12:46:12.718310Z"

Any of:

The date and time when the section was last updated, formatted in ISO 8601.

string (date-time)

updatedBystring or null(Updatedby)

Example:"mman"

Any of:

The user who last updated the section.

string

deletedAtstring or null(Deletedat)

Example:"2025-06-18T12:46:12.718310Z"

Any of:

The date and time when the section was deleted, if applicable, formatted in ISO 8601.

string (date-time)

propertiesobject or null(Properties)

Any of:

Additional properties for the section.

]

Response

[
  {
    "deletable": true,
    "id": "37a49437-e1c8-4697-b1c2-914e2382ea75",
    "name": "Brand Context",
    "order": 2,
    "createdOn": "2025-06-18T12:46:12.718310Z",
    "createdBy": "mman",
    "updatedOn": "2025-06-18T12:46:12.718310Z",
    "updatedBy": "mman",
    "deletedAt": "2025-06-18T12:46:12.718310Z",
    "properties": {}
  }
]