Getting Started
Authentication
All API requests are authenticated with an API key passed in the
x-api-key header. Keys are scoped — create separate keys for each
integration with only the permissions it needs.
Getting a key
- 1 Log in to your Beya dashboard
- 2 Go to Settings → API Keys
- 3 Click Create API Key
- 4 Select the scopes your integration needs
- 5 Copy your key immediately — it is not shown again
Using your key
curl https://api.usebeya.com/v1/contacts \
-H "x-api-key: bk_live_your_key_here"Available scopes
| Scope | Description |
|---|---|
contacts:read | Read contact records |
contacts:write | Create and update contacts |
inbox:read | Read inbox threads and messages |
inbox:write | Send messages and manage threads |
calendar:read | Read calendar events |
calendar:write | Create and update calendar events |
products:read | Read product catalogue |
orders:read | Read orders and fulfilment data |
payments:read | Read payment records |
Key modes
Every key has a mode: test or
live.
| Mode | Prefix | Data |
|---|---|---|
live | bk_live_… | Your real production data |
test | bk_test_… | Sandbox / seeded test data |