---
title: "Retrieve (metadata about) all keys."
method: GET
path: "/keys"
tags: ["keys"]
---

# Retrieve (metadata about) all keys.

`GET /keys`

## Response `200`

List of all keys

- ApiKeysResponse
  - `keys` ApiKey[], required
    - `value` string
    - `description` string, required
    - `actions` string[], required
    - `collections` string[], required
    - `expires_at` integer
    - `id` integer
    - `value_prefix` string

## Changes

- **2024-02-13** `14b1d3553228` — 3 breaking, 2 info
  - the response property `keys/items/allOf[subschema #2]/id` became optional for the status `200`
  - the response property `keys/items/allOf[subschema #2]/value_prefix` became optional for the status `200`
  - removed the required property `keys/items/allOf[subschema #2]/value` from the response with the `200` status
  - added the optional property `keys/items/allOf[#/components/schemas/ApiKeySchema]/value` to the response with the `200` status
  - …1 more
- **2022-08-04** `6c2fe01b69bc` — 1 breaking, 1 warning, 3 info
  - the response property `keys/items/allOf[#/components/schemas/ApiKeySchema]/description` became optional for the status `200`
  - removed the optional property `keys/items/allOf[#/components/schemas/ApiKeySchema]/value` from the response with the `200` status
  - the response property `keys/items/allOf[subschema #2]/id` became required for the status `200`
  - the response property `keys/items/allOf[subschema #2]/value_prefix` became required for the status `200`
  - …1 more

[Change history](https://skmtc.dev/typesense/apis/typesense-api/changes/keys/get.md)

---

[API](https://skmtc.dev/typesense/apis/typesense-api.md) · [All operations](https://skmtc.dev/typesense/apis/typesense-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/typesense/typesense-api/revisions/1d9b3b61638e/schema)