---
title: "Identify your API key"
method: GET
path: "/v1/me"
tags: ["Account", "tier:free"]
---

# Identify your API key

`GET /v1/me`

## Request

- Base URL: `https://api.particle.pro`
- URL: `https://api.particle.pro/v1/me`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Returns the organization, project, and API key a request authenticates as, with the organization's plan. Free: call it to check that a key works and which project it belongs to. A missing, mistyped, revoked, or expired key returns 401 api_key_required. When the organization's access is blocked, it returns the same 402 as every other endpoint, naming the billing state and how to resolve it.

## Response `200`

OK

- Identity
  - `api_key` APIKey, required
    - `created_at` string, date-time, required: When the key was created
    - `created_by` Creator
      - `id` string, required: Creator's user ID
      - `name` string, required: Creator's display name
    - `expires_at` string, date-time: When the key expires, if set
    - `id` string, required: Unique identifier
    - `key_prefix` string, required: Masked key prefix for identification (e.g. pp_abc12345...)
    - `last_used_at` string, date-time: When the key was last used to authenticate a request
    - `name` string, required: Human-readable key name
  - `organization` IdentityOrganization, required
    - `id` string, required: The organization's ID.
    - `name` string, required: The organization's name.
    - `plan` string, required: The organization's billing plan ID, e.g. business or enterprise. Branch on this rather than on plan_display_name.
    - `plan_display_name` string: The plan's name as the dashboard shows it, ready to display. Omitted when it cannot be resolved.
    - `subscription_status` string, required: ACTIVE when the subscription is in good standing. PAST_DUE when a payment failed and is being retried: requests are still served, but the payment method needs updating. CANCELED when the subscription has been canceled and access ends with the current billing period.
  - `project` Project, required
    - `created_at` string, date-time, required: When the project was created
    - `description` string: Project description
    - `id` string, required: Unique identifier
    - `name` string, required: Project display name
    - `slug` string, required: URL-safe project slug, unique within the organization
    - `updated_at` string, date-time, required: When the project was last updated

## Other responses

- `default`: Error

---

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