Link a branch, commit or pull request to a work item
/v1/work-items/{item}/code-references in the Code References API.
curl -X POST https://api.example.test/v1/work-items/$ITEM_ID/code-references \ -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \ -H "Idempotency-Key: 7a2e5f91-1c4b-4d8e-9b3a-6c7d8e9f0a14" \ -d '{"repository_id": "9e8d7c6b-5a49-4382-a716-05f4e3d2c1b0", "kind": "commit", "ref": "a1b2c3d", "title": "Apply the voucher at checkout"}'Links a branch, a commit or a pull request in one of the project's live repositories to the item by hand, for the ones whose name or message left the key out. The address is composed from the repository when url is left out, the state is the kind's default when state is left out, and the same reference linked twice refreshes the row rather than doubling it. Answers 201 with the reference and emits code.branch_linked, code.commit_linked or code.pull_request_linked by kind. Linking a pull request does not move the item: the moves the project asks for follow the host's own word through the webhook.
Requires ability
The token must hold this ability, or the call is refused with 403.
Delivered to every endpoint subscribed to them once the change is made.
MCP tools
Run the same action from an agent, behind the same ability.
Idempotent
Send the header on every call; the same key replays the original response for 24 hours.
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 item, bound by the middleware.
uuidHeader Parameters
A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.
uuidRequest body
JSONWhat the request carriesRequiredapplication/json
A branch, a commit or a pull request to link to the item: the repository it lives in, what it is, its name, sha or number, and optionally its title, address, author and state. Linking the same one twice refreshes the row rather than doubling it.
Responses
201Createdapplication/json
The reference, 201.
400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json
Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.
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 role does not carry work-item:update, or the token is a client guest's.
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.
On this endpoint: RESOURCE_NOT_FOUND: when the item is hidden from the token or missing, or the repository is not the item's project's.
409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json
The key was already used in the last 24 hours with a different request body.
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 repository_id, kind or ref is missing or malformed, or the repository is disconnected.
425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json
The first request with this key is still running; retry in a few seconds and the original response is replayed.
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