Get the caller's account

curl https://api.example.test/v1/me \  -H "Authorization: Bearer $TOKEN"

The caller's account; never paginated.

Read it once per session. Nothing here changes under a running client except by an action the client itself takes (changing alert destinations, linking Telegram, joining a team). Read it on sign-in and after those actions; there is no need to poll it.

current_team is the team the token is scoped to (scope:team:<uuid>), when you still belong to it; null when the token carries no team scope. Its id is the value every team call resolves against.
teams is every team you own or are a member of, the same list as GET /v1/teams.
alert_destinations is the same list as GET /v1/me/alert-destinations; alert_destinations_default is true while no destination has been written and the default routing applies (every class to your linked Telegram chat when there is one, and email for what nothing else carries).
unread_notifications is how many entries of your Notifications Center you have not opened, the number on the sidebar entry.
timezone is the IANA name every timestamp the app shows you is in; the API itself always answers in UTC with an offset.

Requires ability

account:read

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

MCP tool

get_me

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

Responses

200OKapplication/json

The caller's account.

data*

The response's payload.

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

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/me"

{  "data": {    "id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",    "name": "Priya Patel",    "email": "priya@example.com",    "title": "Business Analyst",    "locale": "en",    "timezone": "Asia/Colombo",    "email_verified": true,    "current_team": {      "id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",      "name": "Zuse Technologies",      "owner_user_id": "0c2d8a7e-4b1f-4d3e-9a6b-2f5e8c1d7a90",      "created_at": "2026-11-01T09:00:00+00:00"    },    "teams": [      {        "id": "a83f0d51-4c92-4b7e-8615-2fd9e70a3c86",        "name": "Zuse Technologies",        "owner_user_id": "0c2d8a7e-4b1f-4d3e-9a6b-2f5e8c1d7a90",        "created_at": "2026-11-01T09:00:00+00:00"      }    ],    "alert_destinations": [],    "alert_destinations_default": true,    "unread_notifications": 3,    "telegram_linked": true,    "created_at": "2026-11-03T14:22:00+00:00"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: MeResource;}export interface MeResource {  id: string;  name: string;  email: string;  title: string | null;  locale: string;  timezone: string;  email_verified: boolean;  current_team: unknown[] | null;  teams: unknown[];  alert_destinations: unknown[];  alert_destinations_default: boolean;  unread_notifications: number;  telegram_linked: boolean;  created_at: string | null;}

Get the caller's account

AuthorizationCopy Anchor Link

ResponsesCopy Anchor Link

Authorization

Responses