---
title: "The workspace, plan and key behind this request"
method: GET
path: "/me"
tags: ["Account"]
---

# The workspace, plan and key behind this request

`GET /me`

## Request

- Base URL: `https://yungle.co/api/v1`
- URL: `https://yungle.co/api/v1/me`
- Auth: HTTP bearer

## Response `200`

Account and key details.

- Me
  - `workspace` object, required
    - `id` string, required
    - `email` string, nullable, required
    - `displayName` string, nullable, required
    - `customDomain` string, nullable, required: The verified custom domain, if any.
  - `plan` object, required
    - `tier` string, nullable, required: Null on the free plan.
    - `name` string, nullable, required
    - `status` string, required: Currently one of: `none`, `pending`, `active`, `past_due`, `canceled`, `expired`. Treat unknown values as unknown, not as an error.
    - `quotaBytes` integer, required
    - `usedBytes` integer, required
  - `key` object, required
    - `id` string, required
    - `name` string, required
    - `scopes` string[], required
    - `via` 'key' | 'oauth', required: An API key, or an OAuth grant (a connected app).
    - `canEmail` boolean, required: Whether this credential may make Yungle email anyone.

## Other responses

- `401`: Missing or invalid credential. Codes: `unauthorized`.
- `402`: Needs a paid plan, or prepaid credit for metered usage. Codes: `upgrade_required`, `out_of_credit`.
- `403`: The credential lacks a required scope, or a shared link refused access. Codes: `insufficient_scope`, `password_required`, `wrong_password`, `guests_only`.
- `404`: No such resource in this workspace. Codes: `not_found`.
- `429`: Rate limit or email budget exhausted. Wait for `Retry-After`. Codes: `rate_limited`, `email_budget_exhausted`.
- `500`: Our fault. `details.requestId` ties it to our logs. Codes: `internal_error`.

---

[API](https://skmtc.dev/yungle/apis/yungle-api.md) · [All operations](https://skmtc.dev/yungle/apis/yungle-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yungle/apis/yungle-api/revisions/fee7cb2d7419?raw)