Skip to navigation
PlatformBrand Context

API · Context · List context documents

View as Markdown

List all context documents linked to a brand kit. Supports filtering by canonical_key, searching by document name or type, and ordering by created/modified timestamps.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

brand_idstringRequiredformat: "uuid"
Brand kit UUID

Query parameters

canonical_keystringOptional

Filter by canonical type key (e.g. brand_voice, icps)

searchstringOptional

Search by document name or doc_type

orderingenumOptionalDefaults to -modified
Sort order
Allowed values:

Response

Paginated list of context documents

Errors

401
Unauthorized Error
404
Not Found Error