---
title: "Readiness check"
method: GET
path: "/whoami"
tags: ["Users"]
---

# Readiness check

`GET /whoami`

## Request

- Base URL: `https://api.layout.link/v1`
- URL: `https://api.layout.link/v1/whoami`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

What the credential resolves to. An application secret answers `kind: app` with its environment and approval status; a connected user's token answers `kind: user`; a build grant answers `kind: grant`.

## Headers

- `Layout-Version` '2026-10-01'

## Response `200`

Who you are.

- union
  - object
    - `kind` 'app', required
    - `app` object, required
      - `id` string, required
    - `environment` 'sandbox' | 'live', required
    - `approvalStatus` 'pending' | 'approved' | 'denied' | 'suspended', required
    - `scopes` string[], required
  - object
    - `kind` 'user', required
    - `app` object, required
      - `id` string, required
    - `environment` 'sandbox' | 'live', required
    - `user` object, required
      - `id` string, required
    - `scopes` string[], required
  - object
    - `kind` 'grant', required
    - `app` object, required
      - `id` string, required
    - `environment` 'sandbox' | 'live', required
    - `user` object, required
      - `id` string, required
    - `scopes` string[], required
    - `expiresAt` string, required

## Other responses

- `400`: `unsupported_version`: the Layout-Version header names no version this API answers.
- `401`: The credential was not recognised.
- `403`: The credential is real and may not call this.
- `429`: Too many requests.
- `500`: Layout failed to answer. Retry with backoff.
- `503`: Credentials could not be checked right now.

---

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