Version
GET

Get my dashboard

/v1/me/dashboard in the Me API.

curl "https://api.example.test/v1/me/dashboard?project_id=$PROJECT_ID" \  -H "Authorization: Bearer $TOKEN"

What the My Work dashboard shows the caller, in one payload: their open items by status (counts, open_count), the items that ask for them today most pressing first (focus, each with the item, a reason such as Overdue by 2 days, Due today, Waiting for your review or In progress, a score and a tone), the approval requests waiting on them (approvals_waiting, approvals), their running timer, their time_this_week, the past weeks with time and no timesheet put forward (weeks_to_submit), the running sprints with their progress, their live projects with health and their open items on each, and the latest activity across those projects when they may read the team's log. project_id narrows every section but the activity to one project. A client guest's token reads the approvals and the projects alone, with internal false. The figures come from the same services the application reads, so an agent and the person never disagree.

GET
/v1/me/dashboard

Requires ability

The token must hold this ability, or the call is refused with 403.

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

project_id?|

Narrow every section but the activity to one project.

Formatuuid

Responses

200OK

The summary.

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. On this endpoint: FORBIDDEN: when the token lacks dashboard:read.

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 project_id is not a UUID.

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