Open a branch for a work item
/v1/work-items/{item}/branches in the Code References API.
curl -X POST https://api.example.test/v1/work-items/$ITEM_ID/branches \ -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \ -H "Idempotency-Key: 7a2e5f91-1c4b-4d8e-9b3a-6c7d8e9f0a16" \ -d '{"repository_id": "9e8d7c6b-5a49-4382-a716-05f4e3d2c1b0"}'Opens a branch for the item on the host, in one of the project's repositories connected through the team's GitHub App installation, from the repository's default branch, and links it to the item at once. The name is the workspace's own when name is left out: feature/ or fix/ for a bug, the item's key in lower case, and a slug of its title, so the webhook links everything pushed to it without anyone typing a key. Answers 201 with the branch as a code reference and emits code.branch_linked.
Requires ability
The token must hold this ability, or the call is refused with 403.
Fires one event
Delivered to every endpoint subscribed to it once the change is made.
MCP tool
Runs 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
Where to open the branch and, optionally, what to call it; the workspace proposes a name from the item's key and title when none is given.
Responses
201Createdapplication/json
The branch as a code reference on the item, 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 or the repository 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 is missing or malformed, the name is not one Git accepts, the branch exists already, the repository is disconnected, or the host refuses or does not answer. INTEGRATION_NOT_CONNECTED: when the repository was registered by hand rather than picked from an installation, the installation was forgotten or suspended, or it may not write the repository's contents.
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