listProjects
GET /api/v1/projects
Optional durable initiative. Requires a current registered Agent/account grant bound to the owning workspace; original linked Resource authorization is independent. Managers configure lifecycle/participants through the authenticated browser. Archived Projects reject ordinary edits. Retry receipts and minimal Activity facts commit atomically; detach never deletes the linked Resource. Pagination cursors are opaque and actor/query-bound. Future adapters and unvalidated revision pins fail explicitly.
Access
Section titled “Access”Use a credential with commentary.projects.read.
Provider access, workspace membership, and agent grants are enforced separately. A token does not expand access to a repository or resource. Set up developer access.
Parameters
Section titled “Parameters”| Name | Location | Type | Required | Description |
|---|---|---|---|---|
cursor |
query | string | No | |
limit |
query | integer | No | |
workspaceId |
query | string | Yes | |
search |
query | string | No | |
lifecycle |
query | "active" · "completed" · "archived" |
No | |
visibility |
query | "workspace" · "participants" |
No | |
sort |
query | "recent" · "name" |
No |
Call the endpoint
Section titled “Call the endpoint”Replace path placeholders and your credential. For body operations, create request.json using the required fields above; this command does not invent resource identifiers or consent.
curl --request GET \ 'https://commentary.dev/api/v1/projects' \ --header 'Authorization: Bearer <your-token>'Responses
Section titled “Responses”| Status | Meaning | Payload |
|---|---|---|
200 |
Authorized domain result with the exact applicable ETag. | ProjectAgentlistProjectsOutput |
400 |
Bounded v1 machine-readable failure. | object |
401 |
Bounded v1 machine-readable failure. | object |
403 |
Bounded v1 machine-readable failure. | object |
404 |
Bounded v1 machine-readable failure. | object |
409 |
Bounded v1 machine-readable failure. | object |
412 |
Bounded v1 machine-readable failure. | object |
413 |
Bounded v1 machine-readable failure. | object |
422 |
Bounded v1 machine-readable failure. | object |
428 |
Bounded v1 machine-readable failure. | object |
429 |
Bounded v1 machine-readable failure. | object |
500 |
Bounded v1 machine-readable failure. | object |
503 |
Bounded v1 machine-readable failure. | object |
Successful response fields
Section titled “Successful response fields”| Field | Type | Required | Description |
|---|---|---|---|
data |
object | Yes | |
idempotencyReplayed |
boolean | No |
Recover from errors
Section titled “Recover from errors”Use the returned status and error body. Correct invalid fields before retrying; reconnect or narrow the target for authentication and permission errors. For conditional writes, reload the latest version before preparing a new request. Respect rate-limit headers and retry only when the operation’s idempotency contract permits it.
Contract and related guidance
Section titled “Contract and related guidance”Operation ID: listProjects. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.