Retrieve a brand kit

Sitecore API catalog/Brand Management API/

Request

Retrieves a specific brand kit by its ID. The response includes basic information about the brand kit, such as its name, description, industry, and status. The response does not include the actual content of the brand kit sections or subsections.

If you don't know the brand kit ID, you can use the List brand kits endpoint to retrieve the list of brand kits in your organization.

Security

HTTPBearer

Path

organizationIdstringrequired

The unique identifier of your organization.

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

Example:org_ABCDef123456

brandkitIdstringrequired

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

includeDeletedboolean or null(Includedeleted)

Example:includeDeleted=false

Any of:

Whether to include deleted brand kits 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?includeDeleted=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Brand kit retrieved successfully

Bodyapplication/json

organizationIdstring(Organizationid)required

The unique identifier of your organization.

Example:"org_ABCDef123456"

idstring(Id)required

The unique identifier of the brand kit.

Example:"a1234bcd-efg5-678h-910i-jklmnopqrstu"

namestring(Name)required

The name of the brand kit.

Example:"Powerful EU brand kit"

tagsArray of objects or null(Tags)required

Example:

[]

Any of:

An array of tags associated with the brand kit to categorize its documents.

referencesArray of objects or null(References)required

Example:

[]

Any of:

An array of references associated with the brand kit.

descriptionstring or null(Description)

Example:"Brand kit for the Powerful energy bars EU market."

Any of:

A brief description of the brand kit.

string

brandNamestring or null(Brandname)

Example:"Powerful"

Any of:

The name of the brand associated with this brand kit.

string

companyNamestring or null(Companyname)

Any of:

The name of the company if different from the brand name.

string

logostring or null(Logo)

Example:"https://example.com/logo.png"

Any of:

The URL of the PNG image used as the brand kit logo.

string

statusstring or null(Status)

Example:"Draft"

Any of:

The current status of the brand kit.

string

parentIdstring or null(Parentid)

Example:"a1234bcd-efg5-678h-910i-abcdefghijklmn"

Any of:

The parent brand kit ID. Used when AI creates a new version of the brand kit during brand ingestion to indicate the original brand kit it's based on.

string

parentTypestring or null(Parenttype)

Example:"brandkit"

Any of:

The type of parent this brand kit belongs to.

string

industrystring or null(Industry)

Example:"retail"

Any of:

The industry this brand kit is associated with.

string

createdOnstring or null(Createdon)

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

Any of:

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

string (date-time)

createdBystring or null(Createdby)

Example:"mman"

Any of:

The user who created the brand kit.

string

updatedOnstring or null(Updatedon)

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

Any of:

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

string (date-time)

updatedBystring or null(Updatedby)

Example:"mman"

Any of:

The user who last updated the brand kit, formatted in ISO 8601.

string

deletedAtstring or null(Deletedat)

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

Any of:

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

string (date-time)

lockedboolean or null(Locked)

Example:false

Any of:

Whether the brand kit is locked. A locked brand kit cannot be modified or deleted.

boolean

Response

{
  "organizationId": "org_ABCDef123456",
  "id": "a1234bcd-efg5-678h-910i-jklmnopqrstu",
  "description": "Brand kit for the Powerful energy bars EU market.",
  "name": "Powerful EU brand kit",
  "brandName": "Powerful",
  "companyName": "string",
  "logo": "https://example.com/logo.png",
  "status": "Draft",
  "parentId": "a1234bcd-efg5-678h-910i-abcdefghijklmn",
  "parentType": "brandkit",
  "industry": "retail",
  "createdOn": "2025-06-18T12:46:12.718310Z",
  "createdBy": "mman",
  "updatedOn": "2025-06-18T12:46:12.718310Z",
  "updatedBy": "mman",
  "tags": [],
  "references": [],
  "deletedAt": "2025-06-18T12:46:12.718310Z",
  "locked": false
}