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

# List API keys

`GET /apikey/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/apikey/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

List all API keys for the user. Requires a user authentication (not API key).

## Query parameters

- `limit` integer: The number of items to return.
- `order_by` 'id' | 'created_at' | 'updated_at' | 'name'
- `order_direction` 'asc' | 'desc'
- `cursor` string, nullable: Set the cursor to the next or previous page. You can get the cursor from the previous page's response.

## Response `200`

Successful Response

- PaginatedResponseAPIKeyRead
  - `data` APIKeyRead[]: The list of ResponseItems.
    - `created_at` string, date-time, required
    - `expire_at` string, date-time, nullable
    - `id` string, uuid, required
    - `key_prefix` string, required: The first characters of the key's value, so it can be told apart from another in a list. The value itself is shown once, when the key is created, and is not recoverable afterwards.
    - `last_used_at` string, date-time, nullable: When this key last authenticated a request, to the minute.
    - `name` string, required
    - `org_id` string, required
    - `scope` 'read' | 'write', required: What a key may do. Two values, not a permission matrix. The thing worth stopping is a write nobody watched: a leaked read key exposes what the dashboard already shows the holder, a leaked write key spends credits and sends mail. A free workspace may only mint ``READ``.
    - `updated_at` string, date-time, required
  - `next_page_cursor` string, nullable: The cursor to the next page. If there are no more pages, this is None.
  - `previous_page_cursor` string, nullable: The cursor to the previous page. If there are no previous pages, this is None.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)