List Research v2 linear typed workflows visible to the external token.
GET /api/v2/research-studies
Returns capability version 2 studies with ordered Content, Activity, and Form steps. Research API v1 is a one-release 410 Gone tombstone.
Access
Section titled “Access”Use a credential with commentary.research.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 |
|---|---|---|---|---|
limit |
query | integer | 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/v2/research-studies' \ --header 'Authorization: Bearer <your-token>'Responses
Section titled “Responses”| 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 |
Successful response fields
Section titled “Successful response fields”| Field | Type | Required | Description |
|---|---|---|---|
ok |
true |
No | |
capabilityVersion |
2 |
No | |
studies |
array of object | 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: listResearchWorkflowsV2. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.