---
title: "Retrieve the current credential"
method: GET
path: "/v1/me"
tags: ["account"]
---

# Retrieve the current credential

`GET /v1/me`

## Request

- Base URL: `http://localhost:3030`
- URL: `http://localhost:3030/v1/me`
- Auth: HTTP bearer

Returns the organization, plan, scopes and credit balance of the API key or token making the
request.

## Response `200`

The credential.

- Credential: A credential, its scopes and its organization's credit balance.
  - `object` 'credential', required: The object's type. Always `credential`.
  - `organization` string, required: The organization's id.
  - `organization_name` string, required: The organization's name.
  - `plan` string, required: The organization's plan, such as `free`.
  - `kind` string, required: Whether the credential belongs to a person or a machine. One of `user` or `machine`.
  - `subject` string, required: The id of the API key, user or OAuth client the credential belongs to.
  - `method` string, required: How the request was authenticated. One of `session`, `api_key`, `oauth` or `mcp`.
  - `name` string, required: The API key's name or the user's email address, for display.
  - `scope` string[], required: The credential's scopes, such as `record:read` and `webhook:manage`. A console session also has its role's `*:manage` scopes.
  - `credit_balance` integer, required: The current credit balance.
  - `user` string, nullable, required: The user's id. Null for a machine credential.

## Other responses

- `401`: `credential_missing`, `credential_invalid` or `credential_expired`. The request has no valid credential.
- `403`: `scope_missing`, `person_required`, `api_key_not_accepted` or `entitlement_missing`. The credential or plan does not allow this request. `detail` names the reason.
- `422`: `parameter_invalid`, `id_malformed` or a cursor code. A parameter is missing or invalid. `errors` lists each one.
- `429`: `rate_limited`. Too many requests. Retry after the `Retry-After` interval. Nothing is charged.

---

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