REST API Reference

Programmatically manage your leads, campaigns, accounts, and pipeline. All endpoints use JSON and require API key authentication.

Authentication

All API requests require your API key in the X-API-KEY header. You can find your API key in Settings → API.

Authentication headerHTTP

GET /api/leads/lists HTTP/1.1
Host: outreach.weezly.com
X-API-KEY: sk_live_YOUR_API_KEY
Content-Type: application/json

401 Unauthorized — Returned when the token is missing, malformed, or expired. The response body will be {"error": "Invalid or expired token"}.

All API endpoints are relative to your deployment URL:

Base URL

http://outreach.weezly.com/api/

All errors return a JSON object with an error field:

Error response formatJSON

{
  "error": "Lead list not found"
}

Code	Meaning
200	Success
201	Created — resource successfully created
400	Bad Request — missing or invalid parameters
401	Unauthorized — missing or invalid API key
404	Not Found — resource doesn't exist or doesn't belong to you
409	Conflict — resource already exists (e.g. duplicate webhook URL)
500	Internal Server Error

List endpoints use two pagination styles:

Offset-based

Used by leads, campaign leads. Pass page and limit. Response includes total, page, totalPages.

Cursor-based

Used by campaigns listing. Pass cursor and limit. Response includes nextCursor (null when no more pages).

Manage lead lists, create/update/delete leads, import and export

Create campaigns, launch/stop/pause, get stats and execution data

List LinkedIn accounts, update rate limits, view SSI scores

Manage pipeline stages, contacts, and notes

Fetch performance metrics, time series, and sender/campaign stats