Version
GET

List my work items

/v1/me/work-items in the Work Items API.

curl "https://api.example.test/v1/me/work-items?open=1" \  -H "Authorization: Bearer $TOKEN"

The items assigned to the token holder across every project the token may see, with the same paging, sorting and filters as a project's list. Pass open=1 for what is still to do.

GET
/v1/me/work-items

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
AuthorizationBearer <token>

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

Query Parameters

type?|

Narrow to one kind: story, task, subtask, bug, spike or improvement.

status?|

Narrow to one status: backlog, ready, in_progress, in_review, in_qa, done or cancelled.

open?|

When true, only the items that are neither done nor cancelled.

epic_id?|

Narrow to the items under one epic.

Formatuuid
parent_id?|

Narrow to the items under one parent item.

Formatuuid
assignee_id?|

Narrow to the items one person is doing.

Formatuuid
label_id?|

Narrow to the items carrying one label.

Formatuuid
priority?|

Narrow to one priority: lowest, low, medium, high or highest.

search?|

Words the reference or the title must contain, up to 120 characters.

Lengthlength <= 120
page?integer

The 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.

Range1 <= value
Default1
per_page?integer

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 25.

Range1 <= value <= 100
Default25
sort_by?string

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

Default"created_at"
sort_direction?string

asc or desc. Defaults to desc.

Default"desc"

Value in

  • "asc"
  • "desc"
limit?integer

Alias of per_page, kept for clients that send it. per_page wins when both are sent.

Range1 <= value <= 100

Responses

200OK

One page of the items assigned to the token holder, across every project the token may see.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).

403Forbidden

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.

422Validation failed

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 a filter is malformed.

429Too many requests

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