GET

List RAID items

/v1/projects/{project}/raid-items in the RAID Log API.

curl "https://api.example.test/v1/projects/$PROJECT_ID/raid-items?type=risk&status=open" \  -H "Authorization: Bearer $TOKEN"

The items of one project in the project's order, 25 per page (per_page 1 to 100), each with its owner's and its raiser's names. sort_by takes number, reference, title, type, category, status, score, probability, impact, due_on, review_on, position, created_at or updated_at. type, status, category and owner_id narrow the page to one value each, and search to the items whose reference, title or dependency contain the words.

Requires ability

The token must hold this ability, or the call is refused with 403.

MCP tool

list_raid_items

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken

AuthorizationBearer <token>

A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.

In: header

Path Parameters

project*string

The project, bound by the middleware.

Formatuuid

Query Parameters

type?|

Narrow to one kind: risk, assumption, issue or dependency. An unknown kind is refused.

status?|

Narrow to one status: open, monitoring, mitigating, resolved, closed, occurred or accepted.

category?|

Narrow to one area: technical, schedule, scope, resource, budget, external, security, compliance, quality or other.

owner_id?|

Narrow to the items one person owns.

Formatuuid

search?|

Words the reference, the title or what the item depends on must contain, up to 120 characters.

Lengthlength <= 120

page?integer

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

Range1 <= value

Default1

per_page?integer

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

Range1 <= value <= 100

Default25

sort_by?string

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

Default"created_at"

sort_direction?string

asc or desc. Defaults to desc.

Default"desc"

Value in

"asc"
"desc"

limit?integer

Alias of per_page, kept for clients that send it. per_page wins when both are sent.

Range1 <= value <= 100

Responses

200OKapplication/json

One page of items with their owners and raisers.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description. On this endpoint: FORBIDDEN: when the token is a client guest's or its holder's role on the project does not carry raid:view-any.

404Not foundRESOURCE_NOT_FOUNDapplication/json

An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.

422Validation failedVALIDATION_FAILEDapplication/json

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a role code already taken or a team the caller does not own, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when type, status or category is not one of its values, owner_id is not a uuid, or search is longer than 120 characters.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/raid-items"

{  "data": [    {      "id": "f7a8b9c0-d1e2-4f3a-8b4c-5d6e7f8a9b02",      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",      "number": 4,      "reference": "CRM-RSK-4",      "type": "risk",      "title": "Payment provider sandbox may lag behind production",      "description": "<p>The provider ships new card flows to production weeks before its sandbox, so the checkout tests may pass against behaviour the live gateway no longer has.</p>",      "category": "external",      "probability": 3,      "impact": 4,      "score": 12,      "mitigation": "<p>Run the checkout smoke test against the provider's production account with a test card every Monday.</p>",      "contingency": "<p>Pin the gateway to the last verified flow and raise an incident with the provider.</p>",      "owner_id": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f",      "owner_name": "Nimal Fernando",      "raised_by": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70",      "raised_by_name": "Sithara Perera",      "due_on": null,      "review_on": "2026-11-16",      "depends_on": null,      "status": "monitoring",      "position": 3,      "created_at": "2026-10-28T09:20:00+00:00",      "updated_at": "2026-11-02T15:00:00+00:00"    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 1,    "from": 1,    "last_page": 1,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 1,    "total": 0  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: RaidItemResource[];  links: Links;  meta: Meta;}export interface RaidItemResource {  id: string;  project_id: string;  number: number;  reference: string;  type: string;  title: string;  description: string | null;  category: string;  probability: number | null;  impact: number | null;  score: number | null;  mitigation: string | null;  contingency: string | null;  owner_id: string | null;  owner_name: string | null;  raised_by: string | null;  raised_by_name: string | null;  due_on: string | null;  review_on: string | null;  depends_on: string | null;  status: string;  position: number;  created_at: string | null;  updated_at: string | null;}export interface Links {  first: string | null;  last: string | null;  prev: string | null;  next: string | null;}export interface Meta {  current_page: number;  from: number | null;  last_page: number;  links: Link[];  path: string | null;  per_page: number;  to: number | null;  total: number;}export interface Link {  url: string | null;  label: string;  active: boolean;}

How is this guide?

Last updated on October 29, 2026 at 13:13 UTC

RAID Log API

The RAID log is where a project writes down what may go wrong and what it leans on: risks (something that may happen and would hurt, scored by probability and impact, with a mitigation and a contingency), assumptions (something taken as true for the plan to hold, reviewed until it is confirmed or fails), issues (something that has happened and hurts now, scored by impact) and dependencies (something the project needs from outside itself).

Add a RAID item

/v1/projects/{project}/raid-items in the RAID Log API.