Get a project
/v1/projects/{project} in the Projects API.
curl https://api.example.test/v1/projects/$PROJECT_ID \ -H "Authorization: Bearer $TOKEN"One project. A project outside the token's team or its project scope is 404 RESOURCE_NOT_FOUND.
statusrunsdiscovery,planning,in_development,in_testing,live,maintenance,on_holdandarchived;healthison_track,at_risk,off_trackorunknown, recomputed nightly from overdue items, failing runs, open incidents and stuck approvals once those modules land.visibilityisteamwhen every member of the team sees the project andmembers_onlywhen only its project members do; a client guest always sees a project through a membership row, whatever its visibility.descriptionis HTML filtered to a safe subset;starts_on,target_launch_onandlaunched_onare dates, not timestamps.
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, resolved by the route binder.
uuidResponses
200OKapplication/json
The project.
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.
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