List an artefact's links
/v1/projects/{project}/links in the Links API.
curl "https://api.example.test/v1/projects/$PROJECT_ID/links?artefact_type=work-item&artefact_id=$WORK_ITEM_ID" \ -H "Authorization: Bearer $TOKEN"Every link that starts from or points at one artefact, newest first, each with both ends' types, ids, keys and titles, the kind, the phrase read from the source and the phrase read from the target. artefact_type and artefact_id are required; the artefact must be one the token may see.
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
The artefact's type: epic, work-item, requirement, business-rule, use-case, raid-item, decision, data-entity or glossary-term. Required.
Value in
- "epic"
- "work-item"
- "requirement"
- "business-rule"
- "use-case"
- "raid-item"
- "decision"
- "data-entity"
- "glossary-term"
- "baseline"
- "change-request"
The artefact's id. Required.
uuidResponses
200OKapplication/json
Array of LinkResource
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 link: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 artefact_type is not one of the nine or artefact_id is not a uuid.
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