# Get the dashboard session

Signup

GET `/v1/session`

The signed-in person and account of the session cookie.

**Auth:** the dashboard session cookie.

## Example

cURL:

```shell
curl 'https://socialtap.dev/v1/session' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

## Authorizations

The dashboard's session cookie, not an API key.

## Response

### 200

Get the dashboard session

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` |  |
| `data.account_id` | `string` | The account this session acts on: the one x-account-id named, else the person's own. |
| `data.accounts` | `object[]` | Every account the signed-in person belongs to, their own first, then by when they joined: send one's account_id as x-account-id to act on it. |
| `data.accounts[].account_id` | `string` | The account (acct_…): send it as x-account-id to act on it. |
| `data.accounts[].deletes_at` | `string` (date-time) or `null` | When the account is deleted for good, RFC 3339 UTC: its owner asked to delete it, and starting the dashboard on it (POST /v1/session with x-account-id) cancels that. null when it isn't being deleted. |
| `data.accounts[].joined_at` | `string` (date-time) | When they joined it, RFC 3339 UTC. |
| `data.accounts[].object` | `string` | Always account_membership.<br>One of `account_membership` |
| `data.accounts[].owner_email` | `string` | Its owner's address, which names it. |
| `data.accounts[].role` | `string` | The person's role in it.<br>One of `owner`, `admin`, `member` |
| `data.activated_key_ids` | `string[]` | IDs of the agent's pending live keys this call activated (agent_token); \[\] otherwise. |
| `data.credits_granted` | `integer` | Free credits this call granted (once per account); 0 otherwise. |
| `data.deletion_canceled_at` | `string` (date-time) or `null` | When signing in last canceled this account's scheduled deletion (its API keys stayed revoked: create new ones), RFC 3339 UTC; null when it never was. |
| `data.email` | `string` | The signed-in person's verified email address. |
| `data.expires_at` | `string` (date-time) | When the session ends, RFC 3339 UTC. |
| `data.free_credits_skipped` | `string` or `null` | Why the account this session acts on has no free credits (Account.free_credits_skipped), for its owner; null otherwise.<br>One of `disposable_address`, `domain_daily_limit`, `network_daily_limit`, `mailbox_used` |
| `data.fresh_until` | `string` (date-time) | Until when this session may create API keys and change keys without re-verifying (password or two-factor code), RFC 3339 UTC. |
| `data.new_api_keys` | `object[]` | Keys this call created, with their secrets shown only here (a new account's first key, the first time its dashboard starts); \[\] otherwise. |
| `data.new_api_keys[].created_at` | `string` (date-time) | When the key was created, RFC 3339 UTC. |
| `data.new_api_keys[].created_by_key` | `string` or `null` | The API key (key_…) that last created this key, gave it the admin scope or rotated it: revoking that key also revokes this one if this one has admin. Null when none did, or a person has rotated it in the dashboard since. |
| `data.new_api_keys[].created_by_user` | `string` or `null` | The person (GET /v1/members user_id) who created this key in the dashboard, or whose key created it. They may have left the account since. Null when no person did (an operator, or a key from before this was recorded). |
| `data.new_api_keys[].dashboard` | `boolean` | true for the account's built-in dashboard key: the dashboard's playground runs as it (so its requests are logged, counted and billed like any key's). Nobody holds its secret, so it works only from the signed-in dashboard. Only its spend_limit can be changed (to cap what the playground spends live); renaming, rescoping, restricting, rotating or revoking it is forbidden (details.reason dashboard_key). It is made on first use and revoked with the account. |
| `data.new_api_keys[].expires_at` | `string` (date-time) or `null` | When the key stops working, RFC 3339 UTC; null when it never expires. |
| `data.new_api_keys[].id` | `string` | Key ID (key_…): manage the key with it. It is not the secret. |
| `data.new_api_keys[].ip_allowlist` | `string[]` | IP addresses or CIDR ranges (IPv4 or IPv6) the key works from; \[\] = any. |
| `data.new_api_keys[].last_used_at` | `string` (date-time) or `null` | About when the key was last used (updated at most hourly); null when never. |
| `data.new_api_keys[].name` | `string` | Your label for the key. |
| `data.new_api_keys[].object` | `string` | Always api_key.<br>One of `api_key` |
| `data.new_api_keys[].prefix` | `string` | The secret's first characters, to recognize it. |
| `data.new_api_keys[].previous_secret_expires_at` | `string` (date-time) or `null` | Until then the secret this key had before its last rotation works too (rotate_secret), RFC 3339 UTC; null when none does. |
| `data.new_api_keys[].revoked_at` | `string` (date-time) or `null` | When the key was revoked; null while it is not. |
| `data.new_api_keys[].scopes` | `string[]` | What the key may call: endpoints (data endpoints), jobs (create, read and cancel jobs; includes jobs:read), jobs:read (read jobs and their results), account:read (account, usage, ledger, keys), admin (account settings and key management; includes account:read).<br>One of `endpoints`, `jobs`, `jobs:read`, `account:read`, `admin` |
| `data.new_api_keys[].secret` | `string` | The key itself: send it in the x-api-key header. Shown only once: store it now. |
| `data.new_api_keys[].spend_limit` | `object` or `null` | The key's spend limit and what it used this interval; null when the key has none. |
| `data.new_api_keys[].status` | `string` | pending: created by an agent signup and waiting for the owner's email confirmation (it can only read GET /v1/account). expired: past expires_at.<br>One of `active`, `pending`, `expired`, `revoked` |
| `data.object` | `string` | Always session.<br>One of `session` |
| `data.role` | `string` | The signed-in person's role in this account (account_id): what the dashboard lets them do here.<br>One of `owner`, `admin`, `member` |
| `data.setup_required` | `boolean` | Whether POST /v1/session still has this account's setting up to do: a new account's first key (its secret in its answer, once), or the decision on an agent-made account. False in POST /v1/session's own answer once it has done it. |
| `data.two_factor_enabled` | `boolean` | Whether the signed-in person has two-factor authentication on. |
| `meta` | `object` | The shared route meta (see the API reference introduction). |

### 401

401 Unauthorized.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired. | Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url. |

### 403

403 Forbidden.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code. | Act on details.reason. suspended: contact [support](mailto:support@socialtap.dev). scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP. |

### 429

429 Too Many Requests.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it. | Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask [support](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

operationId `session.get`

---

[HTML version](https://socialtap.dev/docs/reference/signup/session-get/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)