---
title: "Check a key"
method: GET
path: "/me"
tags: ["me"]
---

# Check a key

`GET /me`

## Request

- Base URL: `https://api.fallax.io/v1`
- URL: `https://api.fallax.io/v1/me`
- Auth: HTTP bearer

The workspace this key belongs to and what it may do. One query, so it is the right endpoint for a credential test or a health check.

## Response `200`

Check a key

- Workspace
  - `workspace` object, required
    - `name` string, required
    - `slug` string, nullable, required
  - `key` object, required
    - `name` string, required
    - `scope` 'read' | 'write', required

## Other responses

- `400`: A parameter or body field the API cannot use. The message names the field.
- `401`: No key, an unknown key, or one that has been revoked.
- `403`: A read-only key was used on a write endpoint.
- `404`: No such endpoint, or no such row in this workspace. The two are deliberately indistinguishable from outside: another workspace's ids must not be probeable.
- `405`: The path exists but not with that verb. `Allow` lists the verbs that work.
- `429`: More than 120 requests in a minute on one key. `Retry-After` says how long to wait. A poll every minute, and the paging behind it, is nowhere near this.
- `500`: Our fault. Safe to retry.

---

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