Get gate readiness

Projects module

GET/projects/{id}/gate-readinessprojects.gateReadiness

Lists each criterion of the next gate with whether evidence satisfies it. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requires the capability projects.gate.read.
OAuth scopes: projects.
Error statuses: 400, 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

projects.gateReadiness: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the project.

Response 200: GateReadinessPage

projects.gateReadiness: GateReadinessPage
Field	Type	Required	Description
data	array of GateReadiness	Yes	Items on this page, in the documented default order.
next_cursor	string \| null	Yes	Opaque cursor for the next page; null on the last page.

{
  "data": [
    {
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "gate": 3,
      "criterion_id": "G1.BUDGET_ENVELOPE",
      "blocking": true,
      "satisfied": false
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/projects/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/gate-readiness" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data } = await xos.projects.gateReadiness("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.projects.gate_readiness("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos projects gate-readiness 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f