# Exchange an authorization code for a session and user profile

Called by the app's backend with the client id and secret; no router-level gate.

`POST /api/v1/auth/token`

- Sign-in: None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 300 requests a minute per IP address.

Called by the app's backend with the client id and secret; no router-level gate. Spends the single-use code from `/redirect` and creates a session whose lifetime follows the org's session policy. Answers 400 for an invalid client, secret or code, 403 for agent clients (OAuth2 only), and 401 when the code predates a credentials change.

## Request

Send the body as `application/json`.

| Field          | Type   | Required | Constraints           | Description |
| -------------- | ------ | -------- | --------------------- | ----------- |
| `code`         | string | Yes      | at least 1 characters | -           |
| `clientId`     | string | Yes      | at least 1 characters | -           |
| `clientSecret` | string | Yes      | at least 1 characters | -           |
| `orgId`        | string | Yes      | format `tenantKey`    | -           |

## Example request

Replace each `YOUR_...` value with your own.

```bash title="cURL"
curl -X POST "https://api.console.buildbase.app/api/v1/auth/token" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string",
  "clientId": "YOUR_CLIENT_ID",
  "clientSecret": "string",
  "orgId": "YOUR_ORG_ID"
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/auth/token',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      code: 'string',
      clientId: 'YOUR_CLIENT_ID',
      clientSecret: 'string',
      orgId: 'YOUR_ORG_ID',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/auth/token",
    json={
        "code": "string",
        "clientId": "YOUR_CLIENT_ID",
        "clientSecret": "string",
        "orgId": "YOUR_ORG_ID",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "data": {
    "sessionId": "8wn72JqeEGqTEHtuMajhMkxecCOtX0CiR5U",
    "user": {
      "amr": [],
      "authTime": null,
      "claims": {},
      "country": "",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "currency": "",
      "email": "user@example.com",
      "emailVerified": true,
      "firstAuthAt": "2026-01-01T00:00:00.000Z",
      "id": "000000000000000000000001",
      "image": "",
      "impersonation": {
        "actorName": "E2E Admin 1767225600000",
        "expiresAt": "2026-01-01T00:00:00.000Z",
        "readOnly": true
      },
      "isAnonymous": false,
      "language": "",
      "mfaEnabled": false,
      "name": "Session User harden-audit-imp",
      "phone": "",
      "phoneVerified": false,
      "role": "user",
      "timezone": "",
      "username": ""
    }
  },
  "success": true
}
```

### Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 404 Not Found

**What it means:** An id in the path names nothing in this org.

**What to do:** Check the ids in the path: one of them names nothing in this organization.

```json title="Example"
{
  "success": false,
  "message": "string"
}
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Auth guide](/authentication/overview): how this part of BuildBase works
- [All Auth operations](/http-api/reference/auth)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `auth.token.create` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
