---
title: "Get Current API Key"
method: GET
path: "/v3/api_keys/self"
tags: ["API Keys"]
---

# Get Current API Key

`GET /v3/api_keys/self`

## Request

- Base URL: `https://api.heygen.com`
- URL: `https://api.heygen.com/v3/api_keys/self`
- Auth: API key in header `x-api-key`

Returns non-secret metadata, expiration, and permission scopes for the API key used to authenticate this request. This endpoint accepts API-key authentication only and does not require the key to grant itself a permission scope.

## Response `200`

Successful response

- object
  - `data` CurrentAPIKeyResponse
    - `key_id` string, nullable, required: Stable identifier for this key, matching the key_id shown in the dashboard. Null for legacy keys issued before key identifiers existed.
    - `key_name` string, nullable, required: Human-readable name assigned to this API key.
    - `status` 'active', required: Current key status. A successful response always means the key is active.
    - `scope_mode` 'full' | 'read_only' | 'custom', required: Permission mode applied to this key: full access, read-only access, or an explicit custom allowlist.
    - `scopes` string[], required: Permission grants held by this key, always present and never empty. Custom keys list their explicit grants. Full-access keys report the wildcard '*:*' and read-only keys report '*:read'; both wildcards also cover permissions added to the catalog after the key was issued, which an expanded list could not express. Match these against an operation's x-heygen-required-scopes in the published OpenAPI spec to decide whether this key may call it.
    - `created_at` string, date-time, required: UTC timestamp when this key was created.
    - `updated_at` string, date-time, required: UTC timestamp when this key was last edited.
    - `expires_at` string, date-time, nullable, required: UTC expiration timestamp, or null when this key never expires.
    - `expires_in_seconds` integer, nullable, required: Whole seconds until expiration, or null when this key never expires.

## Other responses

- `400`: Invalid request parameters
- `401`: Authentication failed
- `429`: Rate limit exceeded

## Changes

- **2026-11-03** `7dfa5e59b4f5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/heygen/apis/heygen-external-api/changes/v3/api_keys/self/get.md)

---

[API](https://skmtc.dev/heygen/apis/heygen-external-api.md) - [All operations](https://skmtc.dev/heygen/apis/heygen-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/heygen/apis/heygen-external-api/revisions/7dfa5e59b4f5?raw)