---
title: "List canonical git-hosted result files for a source-backed form."
method: GET
path: "/api/v1/forms/{formId}/git-results"
tags: ["Forms"]
---

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

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

## Request

- Base URL: `https://commentary.dev`
- URL: `https://commentary.dev/api/v1/forms/{formId}/git-results`
- Auth: HTTP bearer

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

## Path parameters

- `formId` string, required

## Query parameters

- `action` 'list' | 'status'
- `owner` string
- `repo` string
- `ref` string
- `branch` string
- `sourcePath` string

## Headers

- `X-Commentary-Workspace-Id` string
- `X-Correlation-Id` string

## Response `200`

Successful response.

- object
  - `ok` unknown
  - `formId` string
  - `target` object
  - `files` object[]
  - `diagnostics` object[]

## Other responses

- `400`: The request was invalid.
- `401`: Authentication is required.
- `403`: The token or session does not have permission for this resource.
- `404`: The resource was not found.
- `429`: The request was rate limited.

---

[API](https://skmtc.dev/commentary/apis/commentary-public-api.md) · [All operations](https://skmtc.dev/commentary/apis/commentary-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/commentary/apis/commentary-public-api/revisions/7aaafc198c52?raw)
