API / get-origin-check-suite-via-api

API

Get an Origin Check Suite via the API

Fetch one check suite by its server-assigned id with GET https://api.cursor.com/v1/origin/repos/{ownerSlug}/{repoName}/check-suites/{checkSuiteId}. Official reference: Origin API → Checks / Get Check Suite (OpenAPI OriginService_GetCheckSuite).

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 takes the suite id Origin returned on upsert (crg_…). This read returns suite metadata only; it does not embed check runs. List the suite's current runs with ListCheckRunsForSuite. A 404 does not tell you whether the id is missing or merely invisible to this credential.

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
checkSuiteId yes Server-assigned check-suite id (crg_…)
curl --request GET \
  --url 'https://api.cursor.com/v1/origin/repos/OWNER_SLUG/REPO_NAME/check-suites/crg_01k2ja2000e0080000000000h8' \
  --header 'Authorization: Bearer YOUR_ORIGIN_TOKEN'

Response

The body is a CheckSuite: server id, repository reference, head SHA, stable key, display name, optional detailsUrl, timestamps, externalId, and actor. Required checks match on the installing app plus the suite key (and optionally a run key); name is display-only.

Example shape from the OpenAPI:

{
  "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"
    }
  }
}

Read the checkSuite.id from a Post Check Run or Batch Upsert response, then call this endpoint when you need suite metadata without paging runs.

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