Sitecore API catalog/Brand Management API/
/
List brand kits

List brand kits

Request

Retrieves a list of brand kits in an organization. The response includes basic information about each 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.

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
Query
pageNumberinteger(Pagenumber)

The page number of the brand kits list to retrieve.

Default:1
Example:pageNumber=1
pageSizeinteger, <= 100(Pagesize)

The number of brand kits to retrieve per page.

Default:50
Example:pageSize=50
parentIdstring or null(Parentid)
Example:parentId=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
statusstring or null(Status)
Example:status=draft
Any of:

The current status of the brand kit, such as draft, inprocess, published, or failed.

string
searchstring or null(Search)
Example:search=Powerful
Any of:

A search term to filter brand kits by name or description.

string
referenceTypestring or null(Referencetype)
Example:referenceType=document
Any of:

The type of reference to filter brand kits by.

string
referenceIdstring or null(Referenceid)
Example:referenceId=rdd1ea98d-92c1-41e3-8179-9417f255e673
Any of:

The unique identifier of the brand kit reference to filter brand kits by.

string
includeDeletedboolean or null(Includedeleted)
Example:includeDeleted=false
Any of:

Whether to include deleted brand kits in the response.

boolean
brandkitIdsArray of strings or null(Brandkitids)
Any of:

A list of brand kit IDs to filter the results by.

<= 10 items
Array of strings
sortBystring(SortByEnum)

The field to sort the brand kits by.

Default:"createdOn"
Enum:"createdOn""updatedOn"
Example:sortBy=createdOn
sortTypestring(SortTypeEnum)

The sort order to sort the brand kits by.

Default:"desc"
Enum:"asc""desc"
Example:sortType=desc
curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/ai/ai-brands-api/api/brands/v1/organizations/org_ABCDef123456/brandkits?pageNumber=1&pageSize=50&parentId=a1234bcd-efg5-678h-910i-abcdefghijklmn&status=draft&search=Powerful&referenceType=document&referenceId=rdd1ea98d-92c1-41e3-8179-9417f255e673&includeDeleted=false&brandkitIds=&sortBy=createdOn&sortType=asc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Brand kits retrieved successfully

Bodyapplication/json
totalCountinteger(Totalcount)required

The total number of brand kits available in the organization.

Example:10
pageSizeinteger(Pagesize)required

The number of brand kits returned per page.

Example:5
pageNumberinteger(Pagenumber)required

The current page number of the brand kits list.

Example:1
dataArray of objects(Data)required

An array of brand kits available in the organization.

Response
{
  "totalCount": 10,
  "pageSize": 5,
  "pageNumber": 1,
  "data": [
    { … }
  ]
}