---
title: "Returns metadata about the API key that authenticated the request."
method: GET
path: "/api/keys/me"
tags: ["api-keys"]
---

# Returns metadata about the API key that authenticated the request.

`GET /api/keys/me`

## Request

- Base URL: `https://api.pricklymails.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pricklymails.com/api/keys/me`
- Auth: HTTP bearer

## Response `200`

Metadata for the authenticating key.

- CurrentKeyResponse: JSON response body for `GET /api/keys/me`.
  - `enabled_checks` string[], required: Verification checks enabled for the key, for example `"syntax"`, `"mx"` or `"smtp"`.
  - `environment` string, required: Environment of the key, matching its prefix: `"live"` or `"test"`.
  - `is_active` boolean, required: Whether the key is currently active (not revoked, not expired).
  - `name` string, required: Display name of the key.
  - `prefix` string, required: Visible prefix (for example `pm_live_abc12345`).
  - `scopes` string[], required: Scopes granted to the key, for example `"email:verify:single"`.
  - `uuid` string, required: Public UUID of the API key.

## Other responses

- `401`: Missing or invalid API key.

---

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