---
title: "List API keys"
canonical_url: https://docs.zvid.io/docs/endpoints/list-api-keys/
source: docs/endpoints/list-api-keys.api.mdx
content_revision: 6338386a1dd87e4a
---

# List API keys

`GET /api/api-keys`

Retrieve all active API keys for the authenticated user

## Authentication

- Option 1: `x-api-key: YOUR_API_KEY` (header). API key for authentication. Create one in your dashboard.
- Option 2: `Authorization: Bearer YOUR_ACCESS_TOKEN`. Dashboard JWT in Authorization: Bearer <token>, only on operations that explicitly list this scheme. Prefer x-api-key for REST integrations. OAuth for hosted MCP is a separate connection at https://mcp.zvid.io/mcp.

Create API keys at [app.zvid.io/api-keys](https://app.zvid.io/api-keys). Keep credentials on your server.

## Parameters

This operation has no path, query, or additional header parameters.

## Request

The shell examples read credentials from `ZVID_API_KEY` (or `ZVID_ACCESS_TOKEN` for Bearer authentication). Set that variable in your environment. Replace sample project, template, job, and asset identifiers with values from your own account.

This operation does not take a request body.

### Request example

```bash
curl --request GET 'https://api.zvid.io/api/api-keys' \
  --header "x-api-key: $ZVID_API_KEY"
```

## Responses


### HTTP 200

API keys retrieved successfully

Content type: `application/json`.

Unknown properties are rejected. Required properties: `apiKeys`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.apiKeys` | array of [ApiKey](#schema-api-key) | Yes |  |

**Nested field: `response.apiKeys`**

**Array item: `response.apiKeys[]`**

Schema: [ApiKey](#schema-api-key).


**Example response**

```json
{
  "apiKeys": [
    {
      "id": 789,
      "name": "Production API Key",
      "keyPrefix": "zvid_d3f4a1b2c3d",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "lastUsedAt": "2025-01-15T10:30:00.000Z",
      "requestsCount": 150,
      "isActive": true
    }
  ]
}
```

### HTTP 401

Unauthorized

Content type: `application/json`.

Unknown properties are rejected. Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.error` | string | Yes | Error type |
| `response.message` | string | No | Human-readable error message |


### HTTP 500

Internal server error

Content type: `application/json`.

Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `response.error` | string | Yes | Error type |
| `response.message` | string | No | Human-readable error message |


## Schema definitions

The following definitions describe the fields referenced above. Expand a definition to inspect its complete contract.


### schema api key list

**ApiKeyList**


Unknown properties are rejected. Required properties: `apiKeys`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `ApiKeyList.apiKeys` | array of [ApiKey](#schema-api-key) | Yes |  |

**Nested field: `ApiKeyList.apiKeys`**

**Array item: `ApiKeyList.apiKeys[]`**

Schema: [ApiKey](#schema-api-key).


### schema api key

**ApiKey**


Unknown properties are rejected. Required properties: `id`, `name`, `keyPrefix`, `createdAt`, `requestsCount`, `isActive`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `ApiKey.id` | integer | Yes |  |
| `ApiKey.name` | string | Yes |  |
| `ApiKey.keyPrefix` | string | Yes | Stored prefix of the key (first characters, used for identification) |
| `ApiKey.createdAt` | string | Yes | Format: `date-time`. |
| `ApiKey.lastUsedAt` | string / null | No | Format: `date-time`. |
| `ApiKey.requestsCount` | integer | Yes | Total number of requests made with this key |
| `ApiKey.isActive` | boolean | Yes | Whether the key is active (this list only returns active keys) |


### schema authentication error

**AuthenticationError**


Unknown properties are rejected. Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `AuthenticationError.error` | string | Yes | Error type |
| `AuthenticationError.message` | string | No | Human-readable error message |


### schema error

**Error**


Required properties: `error`.

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| `Error.error` | string | Yes | Error type |
| `Error.message` | string | No | Human-readable error message |


## Related resources

- [OpenAPI specification](https://docs.zvid.io/openapi.yaml)
- [Project payload schema](https://docs.zvid.io/schemas/render-payload.schema.json)
- [Quick Start](https://docs.zvid.io/docs/quick-start/)
- [Authentication guide](https://docs.zvid.io/docs/authentication/)