---
title: "get_account"
canonical_url: "https://tweetstream.io/docs/api/agent-action-get-account"
last_updated: 2026-11-05
---

# get_account

Read the account: email, name, terms, referral code and credits, stream setup progress, and Discord community standing and notification settings. The email is masked (j***@example.com) unless the request carries a recent email-code sign-in. A section that could not be read is null and named in refusals. Tier read: the API key alone. The MCP tool of the same name needs the tweetstream:account scope.

Canonical URL: https://tweetstream.io/docs/api/agent-action-get-account

## `POST /api/agent/actions/get_account`

`https://tweetstream.io/api/agent/actions/get_account`

## Authorization

| Name | Type | Description |
| --- | --- | --- |
| `Authorization` | `string`, required | Bearer authentication with your TweetStream API key: `Bearer <key>`. |

## Headers

| Name | Type | Description |
| --- | --- | --- |
| `X-TweetStream-Setup-Proof` | `string` | Optional. The setupProof returned by email verification; when present, the account email is shown in full. |

## Body

### Body example

```json
{}
```

## Response fields

| Name | Type | Description |
| --- | --- | --- |
| `discord` | `object`, required |  |
| `discord.billingDms` | `object`, required |  |
| `discord.billingDms.eligible` | `boolean`, required |  |
| `discord.billingDms.enabled` | `boolean`, required |  |
| `discord.community` | `object`, required |  |
| `discord.community.botInstalled` | `boolean`, required |  |
| `discord.community.channelReady` | `boolean`, required |  |
| `discord.community.linked` | `boolean`, required |  |
| `discord.community.membership` | `enum<string>`, required |  |
| `discord.community.multipleLinked` | `boolean`, required |  |
| `discord.community.onboardingRequired` | `boolean`, required |  |
| `discord.community.required` | `boolean`, required | Whether this account is asked to join the TweetStream Discord community. Only a checkout whose status is community_required waits for it. |
| `discord.community.verificationPending` | `boolean`, required |  |
| `discord.community.verified` | `boolean`, required |  |
| `discord.limitAlerts` | `boolean`, required |  |
| `email` | `string`, required |  |
| `name` | `string`, required |  |
| `realtimeSetup` | `object`, required |  |
| `realtimeSetup.standard` | `object`, required |  |
| `realtimeSetup.standard.firstAlertAt` | `string`, required |  |
| `realtimeSetup.standard.lastConnectedAt` | `string`, required |  |
| `realtimeSetup.ultra_speed` | `object`, required |  |
| `realtimeSetup.ultra_speed.firstAlertAt` | `string`, required |  |
| `realtimeSetup.ultra_speed.lastConnectedAt` | `string`, required |  |
| `referral` | `object`, required |  |
| `referral.canRefer` | `boolean`, required |  |
| `referral.code` | `string`, required |  |
| `referral.issuedThisYearCents` | `integer`, required | an integer |
| `referral.nextCreditUseAt` | `string`, required |  |
| `referral.onHold` | `boolean`, required |  |
| `referral.pendingCreditsCents` | `integer`, required | an integer |
| `referral.referrals` | `object[]`, required |  |
| `referral.referrals.amountCents` | `integer`, required | an integer |
| `referral.referrals.createdAt` | `string`, required | a string to be decoded into a Date |
| `referral.referrals.maturesAt` | `string`, required |  |
| `referral.referrals.status` | `enum<string>`, required |  |
| `referral.successfulReferrals` | `integer`, required | an integer |
| `referral.url` | `string`, required |  |
| `refusals` | `object[]`, required |  |
| `refusals.message` | `string`, required |  |
| `refusals.reason` | `enum<string>`, required |  |
| `refusals.section` | `enum<string>`, required |  |
| `terms` | `object`, required |  |
| `terms.acceptedAt` | `string`, required |  |
| `terms.acceptedVersion` | `string`, required |  |
| `terms.currentVersion` | `string`, required |  |
| `terms.needsAcceptance` | `boolean`, required |  |

## Responses

| Status | Description | Headers |
| --- | --- | --- |
| `200` | Success |  |
| `400` | The input does not match the action's schema (INVALID_REQUEST) |  |
| `401` | Missing or invalid API key |  |
| `403` | The request carried a foreign Origin |  |
| `429` | Rate limit reached (RATE_LIMITED); retry after retryAfterSeconds |  |
| `503` | Temporarily unavailable; retry later |  |

### 200

```json
{
  "discord": {
    "billingDms": {
      "eligible": true,
      "enabled": true
    },
    "community": {
      "botInstalled": false,
      "channelReady": false,
      "linked": true,
      "membership": "member",
      "multipleLinked": false,
      "onboardingRequired": false,
      "required": false,
      "verificationPending": false,
      "verified": true
    },
    "limitAlerts": true
  },
  "email": "person@example.com",
  "name": "Market Desk",
  "realtimeSetup": {
    "standard": {
      "firstAlertAt": "2026-10-29T12:20:41.000Z",
      "lastConnectedAt": "2026-11-05T09:14:03.000Z"
    },
    "ultra_speed": {
      "firstAlertAt": null,
      "lastConnectedAt": null
    }
  },
  "referral": {
    "canRefer": true,
    "code": "MARKETDESK",
    "issuedThisYearCents": 0,
    "nextCreditUseAt": null,
    "onHold": false,
    "pendingCreditsCents": 0,
    "referrals": [],
    "successfulReferrals": 0,
    "url": "https://tweetstream.io/signup?ref=MARKETDESK"
  },
  "refusals": [],
  "terms": {
    "acceptedAt": "2026-10-29T12:02:00.000Z",
    "acceptedVersion": "2026-09-28",
    "currentVersion": "2026-09-28",
    "needsAcceptance": false
  }
}
```

### 400

```json
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "reason": "not_offered",
    "retryAfterSeconds": 123
  },
  "next": {
    "message": "<string>",
    "action": "call_action",
    "method": "POST",
    "name": "<string>",
    "url": "<string>",
    "who": "agent"
  }
}
```

### 401

```json
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "reason": "not_offered",
    "retryAfterSeconds": 123
  },
  "next": {
    "message": "<string>",
    "action": "call_action",
    "method": "POST",
    "name": "<string>",
    "url": "<string>",
    "who": "agent"
  }
}
```

### 403

```json
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "reason": "not_offered",
    "retryAfterSeconds": 123
  },
  "next": {
    "message": "<string>",
    "action": "call_action",
    "method": "POST",
    "name": "<string>",
    "url": "<string>",
    "who": "agent"
  }
}
```

### 429

```json
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "reason": "not_offered",
    "retryAfterSeconds": 123
  },
  "next": {
    "message": "<string>",
    "action": "call_action",
    "method": "POST",
    "name": "<string>",
    "url": "<string>",
    "who": "agent"
  }
}
```

### 503

```json
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "<string>",
    "reason": "not_offered",
    "retryAfterSeconds": 123
  },
  "next": {
    "message": "<string>",
    "action": "call_action",
    "method": "POST",
    "name": "<string>",
    "url": "<string>",
    "who": "agent"
  }
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url https://tweetstream.io/api/agent/actions/get_account \
  --header "Authorization: Bearer $TWEETSTREAM_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{}'
```

### JavaScript

```javascript
const response = await fetch("https://tweetstream.io/api/agent/actions/get_account", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.TWEETSTREAM_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

console.log(response.status, await response.json());
```

### Python

```python
import os
import requests

response = requests.post(
    "https://tweetstream.io/api/agent/actions/get_account",
    headers={"Authorization": f"Bearer {os.environ['TWEETSTREAM_API_KEY']}"},
    json={},
)

print(response.status_code, response.json())
```
