Skip to navigation
Runtime API TemplateProjections

List projection documents

Returns documents from a projection read model. Projection auth rules are applied before data is returned.

Authentication

AuthorizationBearer

Runtime bearer accepted by the normal app-scoped pipeline: an API key or OAuth/JWT with the ‘runtime’ scope, or an app-scoped agent service token. Individual operations may require a narrower principal type.

Path parameters

projectionNamestringRequired

Headers

X-CES-Workspace-IDstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"
Optional Workspace runtime selector header. If supplied with workspaceId, both values must match.

Query parameters

limitintegerOptional1-1000Defaults to 50
offsetintegerOptional>=0Defaults to 0
sortstringOptional

asc, desc, or comma-separated field:direction entries, for example submittedAt:desc,lastName:asc.

filterstringOptional

JSON-encoded filter object. Supports equality, $eq, $ne, $in, $nin, $gt, $gte, $lt, $lte, $contains, $startsWith, and $or.

workspaceIdstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"

Optional Workspace runtime selector for preview or validation calls. If supplied with X-CES-Workspace-ID, both values must match.

Response

Projection document page
projectionstring
collectionstring
countinteger
totalCountinteger
documentslist of maps from strings to any
paginationobject
requestedLimitintegerOptional
truncatedbooleanOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error