Sitecore API catalog/Agent API/Brand contexts

Brand contexts

The Brand contexts API lets you retrieve brand contexts, their metadata, nested folder and file trees, and document content.

Operations

List brand contexts

Request

Retrieves all brand contexts available within an organization. Returns metadata only; document content is not included.

Security
HTTPBearer
Headers
x-sc-job-idany(X-Sc-Job-Id)

A unique identifier for the job, used to trace, audit, and revert actions performed by an AI agent through the Agent API.

Example:job-1234
curl -i -X GET \
  https://edge-platform.sitecorecloud.io/stream/ai-agent-api/api/v1/brand-contexts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-sc-job-id: job-1234'

Responses

Successful response

Bodyapplication/json
Array [
brandContextIdstring(Brandcontextid)

The unique identifier of the brand context.

Example:"b1234567-89ab-4cde-f012-3456789abcde"
displayNamestring(Displayname)

The display name of the brand context.

Example:"Contoso"
sourceRefstring or null(Sourceref)
Example:"https://www.contoso.com"
Any of:

The source URL the brand context was bootstrapped from. Null if it was not bootstrapped from a site.

string
runStatusstring or null(Runstatus)
Example:"completed"
Any of:

The status of the most recent bootstrap run. Null if the brand context has never been bootstrapped.

string
createdDateTimestring, (date-time)(Createddatetime)

Date and time the brand context was created.

Example:"2026-07-01T10:00:00Z"
updatedDateTimestring, (date-time)(Updateddatetime)

Date and time the brand context was last updated.

Example:"2026-07-02T11:00:00Z"
]
Response
[
  {
    "brandContextId": "b1234567-89ab-4cde-f012-3456789abcde",
    "displayName": "Contoso",
    "sourceRef": "https://www.contoso.com",
    "runStatus": "completed",
    "createdDateTime": "2026-07-01T10:00:00Z",
    "updatedDateTime": "2026-07-02T11:00:00Z"
  }
]