Get a requirement

curl https://api.example.test/v1/requirements/$REQUIREMENT_ID \  -H "Authorization: Bearer $TOKEN"

One requirement with its owner's and its source stakeholder's names. A requirement of a project the token may not see, or a draft read through a client guest's token, is 404 RESOURCE_NOT_FOUND.

type is functional or non_functional; category and measure are set for a non-functional requirement only; status is draft, in_review, approved, baselined or deprecated; priority is must, should, could or wont; verification_method is test, inspection, analysis or demonstration.

Requires ability

requirement:view

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

MCP tool

get_requirement

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

requirement*string

The requirement, bound by the middleware.

Formatuuid

Responses

200OKapplication/json

The requirement.

data*

The response's payload.

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).

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

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/requirements/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "data": {    "id": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "type": "non_functional",    "number": 3,    "reference": "CRM-NFR-3",    "category": "performance",    "title": "Tier page answers within a third of a second",    "statement": "<p>The system shall render a member's tier page within 300 ms at the 95th percentile with 500 members browsing at once.</p>",    "rationale": "<p>Members open the tier page from the campaign email, and a slow page is read as a broken reward.</p>",    "source_stakeholder_id": "d6e7f8a9-b0c1-4d2e-9f3a-4b5c6d7e8f90",    "source_stakeholder_name": "Amal Jayasuriya",    "source": "Discovery workshop, 14 October",    "priority": "must",    "measure": "p95 under 300 ms at 500 concurrent users, measured on staging",    "verification_method": "test",    "status": "approved",    "owner_id": "c3d4e5f6-a7b8-4c9d-8e0f-1a2b3c4d5e6f",    "owner_name": "Nimal Fernando",    "position": 2,    "version": 0,    "approved_at": "2026-11-05T15:00:00+00:00",    "approved_revision_id": null,    "created_at": "2026-10-28T09:20:00+00:00",    "updated_at": "2026-11-05T15:00:00+00:00"  }}

Type definitions

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

export interface Response {  data: RequirementResource;}export interface RequirementResource {  id: string;  project_id: string;  type: string;  number: number;  reference: string;  category: string | null;  title: string;  statement: string | null;  rationale: string | null;  source_stakeholder_id: string | null;  source_stakeholder_name: string | null;  source: string | null;  priority: string;  measure: string | null;  verification_method: string;  status: string;  owner_id: string | null;  owner_name: string | null;  position: number;  version: number;  approved_at: string | null;  approved_revision_id: string | null;  created_at: string | null;  updated_at: string | null;}

Get a requirement

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Authorization

Path Parameters

Responses