Skip to content

Quick Start

Make your first API call in under 5 minutes.

1. Create an API Token

In Beeving, go to Settings → API Tokens and create a new token with the desired permissions.

Copy the token — it will only be shown once.

2. Your First Request

Test your token by fetching your contacts:

bash
curl https://app.beeving.com/api/v1/contacts \
  -H "Authorization: Bearer YOUR_TOKEN"
js
const response = await fetch('https://app.beeving.com/api/v1/contacts', {
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
})

const { data, meta } = await response.json()
console.log(`${meta.total} contacts found`)
php
$ch = curl_init('https://app.beeving.com/api/v1/contacts');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_TOKEN',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = json_decode(curl_exec($ch), true);
python
import requests

headers = {'Authorization': 'Bearer YOUR_TOKEN'}
r = requests.get('https://app.beeving.com/api/v1/contacts', headers=headers)
data = r.json()
print(f"{data['meta']['total']} contacts found")

3. Create a Contact

bash
curl -X POST https://app.beeving.com/api/v1/contacts \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "alice@example.com",
    "first_name": "Alice",
    "last_name": "Martin",
    "company": "Acme Corp"
  }'

Response:

json
{
  "id": 42,
  "email": "alice@example.com",
  "first_name": "Alice",
  "last_name": "Martin",
  "full_name": "Alice Martin",
  "company": "Acme Corp",
  "status": "active",
  "created_at": "2026-02-23T10:00:00.000Z"
}

4. Create a CRM Lead

Once you have a contact, turn it into a lead:

bash
curl -X POST https://app.beeving.com/api/v1/crm/leads \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": 42,
    "source": "api",
    "status": "new"
  }'

Next Steps

API v1.0