Skip to content

Search stays in your browser.

Open app

List source-authorized Interactions in the granted workspace.

GET /api/v1/interactions

Without commentary.workspaces.read, only requests addressed to the credential owner are listed. Combining that scope with commentary.interactions.read permits current source-authorized workspace conversation reads. Decision receipts, guidance and Fulfillment retain creator authority. Pages use a bounded source authorization scan and may be empty with a continuation cursor.

Use a credential with commentary.interactions.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.

Name Location Type Required Description
limit query integer No
cursor query string No
state query "draft" · "active" · "waiting_for_human" · "waiting_for_agent" · "completed" · "rejected" · "canceled" · "expired" · "failed" No
resourceType query "repository" · "pull_request" · "document" · "draft_review" · "form" · "research_study" · "knowledge_brain" · "web_app_review" · "project" · "tracker" · "review_package" · "project_review_session" · "source_snapshot" No
X-Commentary-Workspace-Id header string No Must match the credential workspace. This header cannot widen grant authority.
X-Correlation-Id header string No

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.

Terminal window
curl --request GET \
'https://commentary.dev/api/v1/interactions' \
--header 'Authorization: Bearer <your-token>'
Status Meaning Payload
200 Successful response. object
400 The request was invalid. ExternalError
401 Authentication is required. ExternalError
403 The token or session does not have permission for this resource. ExternalError
404 The resource was not found. ExternalError
429 The request was rate limited. ExternalError
Field Type Required Description
data array of Interaction Yes
nextCursor string or null Yes

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.

Operation ID: listInteractions. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.