# Get the account, balance and calling key

Account

GET `/v1/account`

The account's balance and plan, the low-balance alert threshold, and the calling key: its scopes, spend limit (with what it used this interval) and expiry. Free; never cached. A pending agent key may call it (and nothing else) to learn when its owner confirmed.

**Auth:** an API key with the `account:read` scope, or the dashboard session.

## Example

cURL:

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

## Authorizations

`x-api-key`stringheaderrequired

Your API key, with the `account:read` scope. [Authentication](https://socialtap.dev/docs/authentication/index.md)

## Response

### 200

Get the account, balance and calling key

| Field | Type | Description |
| --- | --- | --- |
| `data` | `object` |  |
| `data.api_key` | `object` or `null` | The key that made this request; null for a dashboard session. |
| `data.api_key.created_at` | `string` (date-time) | When the key was created, RFC 3339 UTC. |
| `data.api_key.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.api_key.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.api_key.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.api_key.expires_at` | `string` (date-time) or `null` | When the key stops working, RFC 3339 UTC; null when it never expires. |
| `data.api_key.id` | `string` | Key ID (key_…): manage the key with it. It is not the secret. |
| `data.api_key.ip_allowlist` | `string[]` | IP addresses or CIDR ranges (IPv4 or IPv6) the key works from; \[\] = any. |
| `data.api_key.last_used_at` | `string` (date-time) or `null` | About when the key was last used (updated at most hourly); null when never. |
| `data.api_key.name` | `string` | Your label for the key. |
| `data.api_key.object` | `string` | Always api_key.<br>One of `api_key` |
| `data.api_key.prefix` | `string` | The secret's first characters, to recognize it. |
| `data.api_key.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.api_key.revoked_at` | `string` (date-time) or `null` | When the key was revoked; null while it is not. |
| `data.api_key.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.api_key.spend_limit` | `object` or `null` | The key's spend limit and what it used this interval; null when the key has none. |
| `data.api_key.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.available` | `integer` | Credits new requests can set aside now: balance minus what requests in flight and unfinished jobs hold. For a busy account it may lag concurrent requests by about a second. |
| `data.balance` | `integer` | Credits the account owns, including those held by requests in flight and unfinished jobs. |
| `data.created_at` | `string` (date-time) | When the account was created, RFC 3339 UTC. |
| `data.email` | `string` | The owner's email address: sign-in links, receipts and balance alerts go there. |
| `data.free_credits_skipped` | `string` or `null` | Why this account got no free credits when it was confirmed; null when it got them, or isn't confirmed yet. disposable_address: a throwaway mail service. domain_daily_limit, network_daily_limit: too many new accounts today from its email domain, or from its network. mailbox_used: this mailbox already had them. A daily limit is tried again at the next session, on a later day; the others stand. Everything else works as on any account, buying credits included. New values may be added.<br>One of `disposable_address`, `domain_daily_limit`, `network_daily_limit`, `mailbox_used` |
| `data.id` | `string` | Account ID (acct_…). |
| `data.keep_response_bodies` | `boolean` | Whether each request's answer body is kept, for 7 days (GET /v1/requests/{id}/response); off by default. |
| `data.low_balance_threshold` | `integer` or `null` | credits.low fires (event and email) when a request takes the balance from above this to at or below it; null when off. |
| `data.max_rps` | `integer` | The account's runaway-protection ceiling, in requests per second: a safety limit that stops a runaway client, not a plan limit (plans have no rate limit). Requests above it fail with rate_limited (free) and Retry-After; short bursts above it are admitted (the RateLimit-Policy header states the burst). GET /v1/usage/rate shows how close the account runs to it; ask support to raise it. An account that has never paid has a lower ceiling, which its first payment removes within a minute. |
| `data.object` | `string` | Always account.<br>One of `account` |
| `data.plan` | `string` | Plan ID. |
| `data.status` | `string` | unverified: created by an agent signup whose owner has not confirmed by email yet (no free credits, live keys pending).<br>One of `active`, `unverified` |
| `meta` | `object` | The shared route meta (see the API reference introduction). |

### 400

400 Bad Request.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | A parameter is missing or malformed, or the link is not one this endpoint takes. | Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one. |

### 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 `account.get`

---

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