> ## Documentation Index
> Fetch the complete documentation index at: https://docs.overjoy.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Read your businesses, deals, orders and campaigns from your own code. Your first call takes about two minutes.

> [!NOTE]
>
> The API is read-only for now. Version 1 reads data. Creating and updating records comes next, and the [changelog](https://docs.overjoy.ai/changelog.md) will say when.

**1. Create an API key**

In Overjoy, go to **Settings → Developers → API Keys** and click **Create key**. Only brand admins can create keys. Copy the key when it appears, because you won't see it again.

```bash Terminal theme={"dark"}
export OVERJOY_API_KEY="ovj_live_…"
```

**2. Make your first call**

Every call goes to `https://api.overjoy.ai/v1` with your key in the `Authorization` header. `GET /brand` returns the brand the key belongs to, so it's a good first test.

```bash cURL theme={"dark"}
curl https://api.overjoy.ai/v1/brand \
  -H "Authorization: Bearer $OVERJOY_API_KEY"
```

```python Python theme={"dark"}
import os
import requests

response = requests.get(
    "https://api.overjoy.ai/v1/brand",
    headers={"Authorization": f"Bearer {os.environ['OVERJOY_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
print(response.json()["name"])
```

```typescript TypeScript theme={"dark"}
const response = await fetch("https://api.overjoy.ai/v1/brand", {
  headers: { Authorization: `Bearer ${process.env.OVERJOY_API_KEY}` },
});
if (!response.ok) throw new Error(`Overjoy API: ${response.status}`);
const brand = await response.json();
console.log(brand.name);
```

```json 200 OK theme={"dark"}
{
  "object": "brand",
  "id": "brd_wicked-scents",
  "name": "Wicked Scents",
  "timezone": "America/Los_Angeles",
  "key": { "name": "Warehouse order sync", "scopes": ["orders:read"] }
}
```

## Next steps

> [card] [Connect your AI assistant](https://docs.overjoy.ai/mcp-setup.md)
>
> Ask questions about your accounts in plain English, through MCP.

> [card] [Keys and scopes](https://docs.overjoy.ai/keys-and-scopes.md)
>
> Choose what each key can read.

> [card] [Handle errors](https://docs.overjoy.ai/errors-and-limits.md)
>
> Every error has a type, a message and a request ID.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.