---
title: "Get the caller's account"
method: GET
path: "/v1/me"
tags: ["Me"]
---

# Get the caller's account

`GET /v1/me`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/me`
- Auth: HTTP bearer

```bash
curl https://api.subscriby.net/v1/me \
  -H "Authorization: Bearer $SUBSCRIBY_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 (linking an account, changing alert destinations, switching plan). Read it on sign-in and after those actions; there is no need to poll it.

- `plan` is the platform tier's type (`free`, `starter`, `growth`, …) while the subscription is active, or `null` without one. It is the plan that gates what you can do, not the one still being billed while past due.
- `capabilities` lists every capability the tiers can grant, each `true` when your plan or an active add-on grants it. The set is fixed by the platform, so a client can render toggles from the keys without knowing them in advance.
- `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 project call resolves against.
- `teams` is every team you own or are a member of, the same list as [`GET /v1/teams`](https://docs.subscriby.net/api/v1/reference/teams/list-teams).
- `identities` is the same list as [`GET /v1/me/identities`](https://docs.subscriby.net/api/v1/reference/identities).
- `alert_destinations` is the same list as [`GET /v1/me/alert-destinations`](https://docs.subscriby.net/api/v1/reference/alert-destinations); `alert_destinations_default` is `true` while no destination has been written and the default routing applies (every class to your primary connected account, critical classes by email).
- `unread_notifications` is how many entries of your [Notifications Center](https://docs.subscriby.net/api/v1/reference/notifications) you have not opened, the number on the sidebar entry.
- `partner_code` and `partner_link` are your [Partner Program](https://docs.subscriby.net/api/v1/reference/partner-program) code and the web link it rides on, once Subscriby approved you as a partner; `null` before. The full standing, the referrals, the ledger and the payouts are at `GET /v1/me/partner`.

## Response `200`

The caller's account.

- object
  - `data` MeResource, required: The caller's account: who the token belongs to, the team it is scoped to, every team they hold, the platform plan and its capabilities, the accounts linked on the connectors and where alerts go.
    - `id` string, required: The creator's user id.
    - `name` string, required: The creator's name.
    - `email` string, required: The creator's email address.
    - `locale` string, required: The creator's language, as a locale code.
    - `email_verified` boolean, required: Whether the email address has been verified.
    - `plan` string, nullable, required: The platform tier's type (`free`, `starter`, `growth`, …) while the subscription is active, or null without one. It is the plan that gates what the creator can do, not the one still being billed while past due.
    - `capabilities` object, required: Every capability the tiers can grant, each true when the plan or an active add-on grants it: `no_branding`, `custom_handle`, `time_limited_passes`, `coupons`, `free_plans`, `teams`, `disaster_recovery_prevention`, `multi_connector`. The set is fixed by the platform, so a client can render toggles from the keys.
    - `current_team` unknown[], nullable, required: The team the token is scoped to, when the creator still belongs to it; null when the token carries no team scope. Its id is the value every project call resolves against.
      - unknown
    - `teams` unknown[], required: Every team the creator owns or is a member of, the same list as the teams endpoint.
      - unknown
    - `identities` unknown[], required: The accounts linked on the connectors, the same list as the identities endpoint.
      - unknown
    - `alert_destinations` unknown[], required: Where each alert class goes, the same list as the alert destinations endpoint.
      - unknown
    - `alert_destinations_default` boolean, required: True while no destination has been written and the default routing applies: every class to the primary connected account, critical classes by email.
    - `unread_notifications` integer, required: How many Notifications Center entries the creator has not opened, the number on the sidebar entry.
    - `partner_code` string, nullable, required: The creator's Partner Program code once Subscriby approved them as a partner; null before. The full standing is at `GET /v1/me/partner`.
    - `partner_link` string, nullable, required: The web link that code rides on, the address a partner hands out; null until approved.
    - `created_at` string, nullable, required: When the account was created, ISO 8601.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: 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 owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)
