---
title: "List API keys"
method: GET
path: "/v1/api-keys"
tags: ["api-keys"]
---

# List API keys

`GET /v1/api-keys`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/api-keys`
- Auth: HTTP bearer

Returns the workspace's API keys: name, assigned permissions, the location the key is pinned to (if any), and when each was created and last used. Key secrets are never returned. A key is listed only where the caller holds the API key view permission at the key's location; a workspace-wide key needs that permission for the whole workspace.

**Notes.**
- Not paginated. Revoked keys are listed too (`revokedAt` set).

## Response `200`

Success.

- object
  - `data` ApiKey[], required
    - `id` string, required
    - `name` string, required
    - `preview` string, required: The first characters of the key (`ak_us_live_Ab3x`), to recognise it. Not usable as a credential.
    - `permissions` union, required: `resource.action` permissions, or `"all"` (every permission, now and later).
      - 'all'
      - string[]
    - `nodeId` string, nullable, required: The location the key is pinned to (it can act only there and below). Null = workspace-wide.
    - `lastUsedAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `expiresAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `expired` boolean, required
    - `revokedAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `createdAt` string, required: ISO-8601 timestamp (UTC).

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

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