Skip to content

Search stays in your browser.

Open app

List canonical git-hosted result files for a source-backed form.

GET /api/v1/forms/{formId}/git-results

Discovers files in the canonical results directory near the form source path. Use action=status for read-only sync status and canonical location details.

Use a credential with commentary.forms.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
formId path string Yes Form id or reference id.
action query "list" · "status" No
owner query string No
repo query string No
ref query string No
branch query string No
sourcePath query string 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/forms/<formId>/git-results' \
--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
ok true No
formId string No
target object No
files array of object No
diagnostics array of object No

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: listFormGitResults. Download the OpenAPI contract for complete constraints and code generation. Browse endpoints.