Getting started
Fundamentals
The core objects you work with — accounts, providers, methods, and how requests are shaped.
A few concepts appear throughout the API. Learn them once and the rest of the reference reads quickly.
Provider
A provider is the external platform an account belongs to. Today CorrectInbox supports LinkedIn, so every account has provider: "LINKEDIN". The field exists so your integration keeps working as more providers are added.
Account
An account is a provider profile your user has connected to CorrectInbox. Almost every method runs on behalf of an account, so you pass an account_id (prefixed acc_) with the request.
{
"id": "acc_8f21c0",
"provider": "LINKEDIN",
"name": "Aditya Sharma",
"status": "connected",
"created_at": "2026-02-01T09:12:00Z"
}
You connect accounts from the dashboard or programmatically — see Link an account. CorrectInbox keeps each account's session healthy on its own; you never manage credentials in your own code.
Methods
Methods are the actions you can take with an account: search, messaging, campaigns, engagement, posts and network. They are grouped in the sidebar under Methods.
Requests and responses
- The base URL is
https://api.correctinbox.com/v1. - Request and response bodies are JSON. Send
Content-Type: application/jsononPOST/PUT. - Authentication is the
X-API-KEYheader on every request. - IDs for CorrectInbox objects are prefixed by type:
acc_(account),cmp_(campaign),lst_(lead list),cht_(chat),msg_(message). Provider identifiers (such as a profile id) are returned as‑is. - Timestamps are ISO 8601 in UTC.
Expected failure modes
Outreach runs against a live third‑party platform, so some failures are normal and your integration should handle them:
- An account can become disconnected and need reconnecting — watch its connection status.
- A provider may rate‑limit or restrict an action for a specific account. CorrectInbox paces activity to stay within safe limits, but limits still apply per account.
- Search and other reads can return empty results for an account with limited standing on the provider. This is a property of that account, not an error.
See Errors for the error shape and Rate limits for pacing.