---
title: "Who am I"
description: "The calling credential: its workspace, the API key (name, prefix, scope preset) or the OAuth sign-in (the app and the member it acts for), the capabilities it may use after every clamp, and the workspace's rate limit. `GET /api/v1/whoami`"
url: https://www.unitpost.com/docs/platform/get-whoami
section: "Platform API reference"
updated: 2026-10-13
---
# Who am I

`GET /api/v1/whoami`

The calling credential: its workspace, the API key (name, prefix, scope preset) or the OAuth sign-in (the app and the member it acts for), the `capabilities` it may use after every clamp, and the workspace's rate limit. Call it first to plan within what the credential may do instead of learning by `403`. Never returns the secret. Requires no capability: any valid credential may call it.

## Response fields (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | — |
| `workspace` | object | yes | — |
| `credential` | object | yes | Never the secret. |
| `capabilities` | string[] | yes | What this credential may do, after every clamp: a call that needs another one answers 403 `insufficient_scope`. |
| `rate_limit` | object | yes | — |

## Responses

| Status | Description |
| --- | --- |
| 200 | The caller. |
| 401 | Missing or invalid API key. |
| 404 | The credential's key or workspace no longer exists. |
| 422 | A query key (this operation takes none). |

## Example request

```bash
curl -X GET 'https://www.unitpost.com/api/v1/whoami' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
```

## Example response (200)

```json
{
  "object": "whoami",
  "workspace": {
    "id": "id_123",
    "name": "Example",
    "slug": "string"
  },
  "credential": {
    "type": "api_key",
    "id": "id_123",
    "name": "Example",
    "prefix": "string",
    "scope": "full",
    "created_at": "2026-01-01T00:00:00.000Z",
    "last_used_at": "2026-01-01T00:00:00.000Z",
    "client_id": "client_123",
    "client_name": "string",
    "user": "string"
  },
  "capabilities": [
    "string"
  ],
  "rate_limit": {
    "limit": 1,
    "window_seconds": 0
  }
}
```

## Links

- HTML reference (with Node.js, Python, Ruby, PHP, Laravel, Go, Java, Rust, .NET and CLI examples): https://www.unitpost.com/docs/platform/get-whoami
- OpenAPI 3.1 (full schemas): https://www.unitpost.com/api/v1/openapi.json