API / list-origin-check-suites-for-commit-via-api

API

List Origin Check Suites for a Commit via the API

Page check suites reported against one commit with GET https://api.cursor.com/v1/origin/repos/{ownerSlug}/{repoName}/commits/{sha}/check-suites. Official reference: Origin API → Checks / List Check Suites for Commit (OpenAPI OriginService_ListCheckSuitesForCommit).

Origin is in Early Beta and subject to change. Authenticate with an installation access token (oit_…) or a user access token that carries repository:checks:read. Availability: Early Beta per the API overview.

The path sha must be a commit SHA (40- or 64-character hex). The response returns only the latest attempt of each suite (per reporting actor and suite key); superseded attempts are omitted. Suite metadata only — no embedded runs. Suite ids are time-sortable TypeIDs prefixed crg_…. Default page size is 30; values above 100 clamp to 100. A supplied pageToken encodes the last-seen check-suite id scoped to this commit, so pageSize on a follow-up request is ignored.

Cost: 1 point against the principal budget (ordinary read).

Path parameters

Param Required Meaning
ownerSlug yes Owning entity's unique slug
repoName yes Repo name, unique to the owner
sha yes Commit SHA (40- or 64-char hex) to list suites for

Query parameters

Param Required Meaning
pageSize no Max suites to return (default 30, max 100)
pageToken no Opaque cursor from a previous nextPageToken
curl --request GET \
  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/commits/9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4/check-suites?pageSize=30' \
  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

Response

The body carries checkSuites and an optional nextPageToken (empty when no next page). Each suite includes id (crg_…), repository, head sha, stable key, display name, optional detailsUrl, timestamps, externalId, and actor.

Example shape from the OpenAPI:

{
  "checkSuites": [
    {
      "id": "crg_01k2ja2000e0080000000000h8",
      "repository": {
        "id": "repo_01k2ja2000e0080000000000q4",
        "name": "rocket",
        "owner": {
          "slug": "acme",
          "id": "ns_01k2ja2000e0080000000000p3",
          "type": "team"
        }
      },
      "sha": "9a41f0c3d2b8e7f6a5c4d3e2f1b0a9c8d7e6f5a4",
      "key": "ci-8842",
      "name": "CI",
      "detailsUrl": "https://ci.acme.dev/runs/8842",
      "createdAt": "2026-08-01T09:30:00Z",
      "updatedAt": "2026-08-02T14:45:00Z",
      "externalId": "build-8842",
      "actor": {
        "user": {
          "id": "user_01k2ja2000e0080000000000c3",
          "email": "jane@acme.dev"
        }
      }
    }
  ]
}

Take a suite id from this list, then fetch suite metadata with Get Check Suite or page its runs with List Check Runs for Suite.

Base URL: https://api.cursor.com/v1/origin.