# Get the signed-in user's profile

Returns the caller's profile together with per-session facts: whether the email can be changed, how and when this session last proved who it is, and whether...

`GET /api/v1/public/profile`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- 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).

Returns the caller's profile together with per-session facts: whether the email can be changed, how and when this session last proved who it is, and whether there is a password to change. Answers 404 when the user no longer exists.

## Request

This operation takes no parameters and no body.

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X GET "https://api.console.buildbase.app/api/v1/public/profile" \
  -H "x-session-id: $BUILDBASE_SESSION_ID"
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/profile',
  {
    method: 'GET',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
    },
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import os

import requests

response = requests.get(
    "https://api.console.buildbase.app/api/v1/public/profile",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "amr": ["pwd"],
  "authTime": "2026-01-01T00:00:00.000Z",
  "canChangeEmail": true,
  "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": "http://localhost:4443/buildbase-local-assets/orgs/000000000000000000000002/assets/file-000000000000000000000003.png",
  "isAnonymous": false,
  "language": "",
  "mfaEnabled": false,
  "name": "Session User uploads-1767225600000",
  "passwordSet": true,
  "passwordSignIn": false,
  "phone": "",
  "phoneVerified": false,
  "role": "user",
  "timezone": "",
  "username": ""
}
```

### 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.

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 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

- [Profile guide](/users/overview): how this part of BuildBase works
- [All Profile operations](/http-api/reference/profile)
- [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 `profile.list` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
