Skip to content

OutboundSync API

When to use this guide: Use this section when you want a programmatic way to verify an OutboundSync API key, inspect which CRM connections it can access, or help an AI coding assistant build against OutboundSync.

The OutboundSync API is the developer surface for OutboundSync itself. It is separate from the Smartlead, Instantly, EmailBison, HeyReach, and other platform API keys you save so OutboundSync can read from those tools.

Base URL

Section titled “Base URL”
https://app.outboundsync.com/api/v1

All current API routes live under /api/v1 and use Bearer authentication.

Authorization: Bearer osapi_<your-secret>

Start here

Section titled “Start here”
Creating API keys Create, store, rotate, revoke, and scope OutboundSync API keys from the admin app.
Get account and connections Call GET /api/v1/me to verify a key and see the CRM connections it can access.
Errors and rate limits Handle invalid keys, disabled API access, rate limits, and retry behavior.

Authentication flow

Section titled “Authentication flow”
Sequence diagram showing a client calling GET /api/v1/me with a Bearer API key, OutboundSync applying an IP rate limit, validating the key hash, resolving API-enabled CRM connections, and returning a MeResponse.
How OutboundSync validates an API key before returning account and connection details.

Quick test

Section titled “Quick test”

Use GET /api/v1/me as the first request for a new integration. A successful response proves the key is valid and tells you whether the key is account-wide or scoped to one CRM connection.

Terminal window
curl https://app.outboundsync.com/api/v1/me \
  -H "Authorization: Bearer osapi_<your-secret>"

Ask an AI coding assistant

Section titled “Ask an AI coding assistant”

Paste this prompt into Cursor, Claude Code, Codex, or another coding assistant after you create an API key:

Verify my OutboundSync API key against GET https://app.outboundsync.com/api/v1/me.
Docs: https://outboundsync.com/docs/api/endpoints/get-account-and-connections/
Use Bearer authentication. Parse the connections array and tell me which CRM connections this key can access.

OutboundSync docs pages also have mirrored Markdown endpoints under /content/docs/...md/, so coding assistants can retrieve the same reference content in a machine-readable form.