---
title: "Get details of an API-Key"
method: GET
path: "/auth/api-key/{key}"
tags: ["auth"]
---

# Get details of an API-Key

`GET /auth/api-key/{key}`

**Permission required:** view_api_keys

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- APIKeyModel
  - `active` boolean, required — Is the API Key active or not
  - `expire_at` string, date-time — The date at which the API Key will expire
  - `roles` TokenRoleModel[] — the user roles
    - `document_id` string — limited to a document
    - `inbox` string
    - `role` string, required
  - `token` string, required — Token value
  - `user` string, required — Bearer user

## Other responses

- `403` — Permission insufficient

---

[API](https://skmtc.net/contractp/apis/contract-p.md) · [All operations](https://skmtc.net/contractp/apis/contract-p/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/contractp/contract-p/revisions/8ce53ebd6bd3/schema)