Workspace

List pages

List pages in a brain with offset pagination. Filter by bucket or status, and optionally include deprecated pages that are normally hidden.

Authentication

x-api-keystring

Your Living Brain API key. Create one from the dashboard; keys are scoped to an organization and carry the role of the member they were issued to.

Path parameters

brainIdstringRequired
Brain id

Headers

x-subject-idstringRequired
Identifies the end user the request is made on behalf of. Brains are owned by a subject, so this determines which brains the caller can see.

Query parameters

limitintegerOptional
offsetintegerOptional
includeDeprecatedbooleanOptional
bucketenumOptional
Allowed values:
statusenumOptional
Allowed values:

Response

itemslist of objects
The pages on this page of results.
totalinteger

Total pages matching the filter (ignores pagination)

limitinteger
Applied page size
offsetinteger
Applied offset

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error