---
title: "Verify your API key"
method: GET
path: "/v1/me"
tags: ["Auth"]
---

# Verify your API key

`GET /v1/me`

## Request

- Base URL: `https://app.getdealboard.com`
- URL: `https://app.getdealboard.com/v1/me`
- Auth: HTTP bearer

Returns the calling user, their workspace, and the key in use. The fastest way to confirm a key works.

## Response `200`

OK

- Me
  - `user` object, required
    - `id` string, uuid, required
    - `email` string, email, required
    - `name` string, nullable, required
  - `workspace` object, required
    - `id` string, uuid, required
    - `name` string, required
    - `plan` 'free' | 'standard', required
  - `apiKey` object, nullable, required: The API key in use, or null when authenticated via OAuth.
    - `id` string, uuid, required
    - `name` string, required
  - `auth` object, required: How the caller authenticated and what it may do.
    - `kind` 'api_key' | 'oauth', required
    - `scopes` string[], required: Granted scopes. API keys hold the full set (role is the gate); OAuth tokens hold exactly what the user consented to. - `deals:read` — List, search, and read deals plus their notes and activity. - `deals:write` — Create deals, update fields, move stages, and add notes. - `leads:read` — Read inbound leads and their enrichment payloads. - `leads:write` — Triage leads, promote them to deals, and write enrichment back. - `pipeline:read` — Read pipeline summaries, weighted pipeline, report cards, and export PNGs.
    - `client` object, nullable, required: The OAuth client, when kind = oauth.
      - `id` string

## Other responses

- `401`: Missing or invalid API key.
- `429`: Rate limit exceeded.

---

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