# shares.inbox

`GET /api/public/v1/shares/inbox`

Copies addressed to the verified email of this key's owner, in any state, newest first; accept one into this workspace with shares.accept.

- Capability: `profile.read`
- Command: no
- MCP tool: `shares_inbox`

## Response

`200` with `{ data, correlation_id }`.

| Field | Type | Always present | Description |
|---|---|---|---|
| `data` | array<object> | yes |  |
| `data[].id` | string (uuid) | yes |  |
| `data[].state` | "preparing" \| "available" \| "importing" \| "delivered" \| "declined" \| "revoked" \| "expired" \| "failed" | yes |  |
| `data[].profile_name` | string | yes |  |
| `data[].os` | "windows" \| "linux" | yes |  |
| `data[].source_revision` | integer | no | Committed revision the copy is pinned to (absent for configuration-only copies) (min -9007199254740991, max 9007199254740991) |
| `data[].categories` | array<"cookies" \| "local_storage" \| "indexed_db" \| "service_workers" \| "extensions" \| "bookmarks" \| "history" \| "open_tabs" \| …> | yes | Browser data carried beyond the configuration |
| `data[].recipient_email` | string | yes |  |
| `data[].message` | string | no |  |
| `data[].expires_at` | string (date-time) | yes |  |
| `data[].created_at` | string (date-time) | yes |  |
| `data[].delivered_at` | string (date-time) | no |  |
| `data[].ended_at` | string (date-time) | no |  |
| `data[].failure` | object | no |  |
| `data[].failure.code` | string | yes |  |
| `data[].failure.message` | string | no |  |
| `data[].progress` | object | no |  |
| `data[].progress.waiting_for_machine` | boolean | yes |  |
| `data[].progress.phase` | string | no |  |
| `data[].progress.pct` | integer | no | (min -9007199254740991, max 9007199254740991) |
| `data[].progress.attempts` | integer | yes | (min -9007199254740991, max 9007199254740991) |
| `data[].sender_workspace` | string | no |  |
| `data[].sender_email` | string | no |  |
| `data[].received_profile_id` | string (uuid) | no | The profile this copy became in your workspace, once accepted |
| `correlation_id` | string (uuid) | yes |  |
| `email` | string \| null | no | The verified email copies are matched against |

New fields can appear at any time; ignore the ones you do not know.

## Errors

| Code | HTTP | Retryable |
|---|---|---|
| `UNAUTHENTICATED` | 401 | no |
| `FORBIDDEN` | 403 | no |
| `RATE_LIMITED` | 429 | yes |
| `DEPENDENCY_UNAVAILABLE` | 503 | yes |
| `UNKNOWN` | 500 | no |

## Example (curl)

```bash
curl "https://browlix.com/api/public/v1/shares/inbox" \
  -H "Authorization: Bearer $BROWLIX_API_KEY"
```

## Example (TypeScript SDK)

```ts
import { Browlix } from "@browlix/sdk";

const bx = new Browlix({ apiKey: process.env.BROWLIX_API_KEY! });
const reply = await bx.call("shares.inbox");
console.log(reply.data);
```

## Example (Python)

```python
import os
import requests

r = requests.get(
    "https://browlix.com/api/public/v1/shares/inbox",
    headers={"Authorization": f"Bearer {os.environ['BROWLIX_API_KEY']}"},
    timeout=60,
)
print(r.status_code, r.json())
```

## Example (MCP)

```json
{
  "method": "tools/call",
  "params": {
    "name": "shares_inbox",
    "arguments": {}
  }
}
```