Quickstart

Create a key and make your first request.

1. Create a workspace API key

   In your dashboard go to Configuration → Integrations → REST API and create a key. For this guide, give it salesbot:contacts:read and publishing:accounts:read. Copy the key; it is shown only once.

2. Find your domain

   Your API lives on the same domain you sign in to. In the examples below, replace app.example.com with it.

3. Check the key

   curl https://app.example.com/api/v1/account \
     -H "Authorization: Bearer osk_YOUR_SECRET"
   

   {
     "data": {
       "id": "c2a4f0d1-58e4-4c1b-a1f7-2b6f3e9d0a11",
       "name": "Acme Marketing",
       "created_at": "2026-01-14T10:22:31+00:00"
     }
   }
   

   The id is your workspace UUID. You need it for the Publishing API.

Messaging

List your contacts:

curl "https://app.example.com/api/v1/contacts?per_page=10" \
  -H "Authorization: Bearer osk_YOUR_SECRET"

Lists return data, links and meta. Use per_page (up to 100) and page to move through them. See the Messaging API reference for every endpoint.

Publishing

Publishing URLs include your workspace UUID:

curl https://app.example.com/os/api/WORKSPACE_UUID/accounts \
  -H "Authorization: Bearer osk_YOUR_SECRET"

To create and schedule a post, you need the account ids from that response. This also needs publishing:posts:write and publishing:posts:publish on your key:

curl -X POST https://app.example.com/os/api/WORKSPACE_UUID/posts \
  -H "Authorization: Bearer osk_YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "accounts": [12],
    "date": "2026-10-20",
    "time": "09:00",
    "timezone": "Europe/London",
    "schedule": true,
    "versions": [
      { "account_id": 0, "is_original": true, "content": [ { "body": "Our autumn sale starts today!" } ] }
    ]
  }'

Next steps

Permissions

Pick the narrowest set your integration needs.

Webhooks

React to events instead of polling.