List use cases
/v1/projects/{project}/use-cases in the Use Cases API.
curl "https://api.example.test/v1/projects/$PROJECT_ID/use-cases?status=approved" \ -H "Authorization: Bearer $TOKEN"The use cases of one project in the project's order, 25 per page (per_page 1 to 100), each with its actor persona's name and without its steps, which the single read carries. sort_by takes number, reference, title, status, priority, frequency, position, created_at or updated_at. status, priority and persona_id narrow the page to one value each, and search to the use cases whose reference, title or goal contain the words.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken 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
The project, bound by the middleware.
uuidQuery Parameters
Narrow to one status: draft, in_review, approved or deprecated. An unknown status is refused.
Narrow to one MoSCoW priority: must, should, could or wont.
Narrow to the use cases one persona acts in.
uuidWords the reference, the title or the goal must contain, up to 120 characters.
length <= 120The 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.
1 <= value1Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.
1 <= value <= 10025The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.
"created_at"asc or desc. Defaults to desc.
"desc"Value in
- "asc"
- "desc"
Alias of per_page, kept for clients that send it. per_page wins when both are sent.
1 <= value <= 100Responses
200OKapplication/json
One page of use cases with their actors; the steps are read one use case at a time.
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.
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 status or priority is not one of its values, persona_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.
How is this guide?
Last updated on
Use Cases API
A use case is how an actor reaches a goal with the system, step by step: the persona who acts, the other actors in the room, the goal, what triggers it, what must be true before and after, how often it happens, and the steps (what the actor does and what the system does in reply) in a main flow with alternate and exception flows branching off numbered main steps.
Add a use case
/v1/projects/{project}/use-cases in the Use Cases API.