API Reference

The Reached API provides a set of RESTful endpoints to manage your outbound calling workflow. All endpoints accept and return JSON.

Base URL

https://kdjmltmhxvvmiuehafgl.supabase.co/functions/v1/api-gateway/v1

Authentication

All requests must include a valid API key in the Authorization header:

Authorization: Bearer rchd_live_xxxxxxxxxxxx

Learn more about authentication

See the full authentication guide for details on generating and managing API keys.

Available Resources

Leads

Create, list, get, and update leads in your workspace.

Campaigns

Access calling campaigns and add leads for parallel dialing.

Statistics

Get the same numbers as the Statistics page, with filters and breakdowns.

Call Logs

Retrieve call history with recordings, transcripts, and dispositions.

Webhooks

Subscribe to real-time event deliveries as an alternative to polling.

Workspaces

List workspaces and map workspace_id values from leads and call logs.

Dispositions

List all call dispositions including built-in and custom ones.

Tasks

Create and manage follow-up tasks linked to leads.

SMS

Retrieve SMS messages and conversations (sent and received).

Endpoint Summary

Leads

Method	Endpoint	Description
`POST`	`/v1/leads`	Create a lead
`GET`	`/v1/leads`	List leads (supports batch retrieval via `ids`)
`GET`	`/v1/leads/:id`	Get a lead
`PUT`	`/v1/leads/:id`	Update a lead
`POST`	`/v1/leads/:id/enrich`	Enrich a lead

Campaigns

Method	Endpoint	Description
`GET`	`/v1/campaigns`	List campaigns
`GET`	`/v1/campaigns/:id`	Get a campaign
`GET`	`/v1/campaigns/:id/stats`	Get campaign statistics
`POST`	`/v1/campaigns/:id/leads`	Add leads to a campaign
`DELETE`	`/v1/campaigns/:id/leads/:lead_id`	Remove a lead from a campaign

Statistics

Method	Endpoint	Description
`GET`	`/v1/stats`	Get statistics (supports `period`, filters and `group_by`)

Call Logs

Method	Endpoint	Description
`GET`	`/v1/call-logs`	List call logs (supports `updated_since`, `include`, `is_conversation`)
`GET`	`/v1/call-logs/:id`	Get a call log (includes transcript, summary, notes)
`GET`	`/v1/call-logs/:id/recording`	Get a fresh presigned recording URL

Agents

Method	Endpoint	Description
`GET`	`/v1/agents`	List agents (active users)

Webhooks

Method	Endpoint	Description
`POST`	`/v1/webhooks`	Create a webhook subscription
`GET`	`/v1/webhooks`	List webhooks
`DELETE`	`/v1/webhooks/:id`	Delete a webhook
`POST`	`/v1/webhooks/:id/rotate-secret`	Rotate a webhook signing secret

Workspaces

Method	Endpoint	Description
`GET`	`/v1/workspaces`	List workspaces

Dispositions

Method	Endpoint	Description
`GET`	`/v1/dispositions`	List all dispositions (built-in + custom)

Tasks

Method	Endpoint	Description
`POST`	`/v1/tasks`	Create a task
`GET`	`/v1/tasks`	List tasks

SMS

Method	Endpoint	Description
`GET`	`/v1/sms-messages`	List SMS messages (sent and received)
`GET`	`/v1/sms-messages/:id`	Get an SMS message
`GET`	`/v1/sms-conversations`	List SMS conversations (supports `unread`, `lead_id`, `phone`)
`GET`	`/v1/sms-conversations/:id`	Get a conversation with full message history

API documentation

Core endpoints

Webhook

API Reference

API Reference

Base URL

Authentication

Learn more about authentication

Available Resources

Leads

Campaigns

Statistics

Call Logs

Webhooks

Workspaces

Dispositions

Tasks

SMS

Endpoint Summary

Leads

Campaigns

Statistics

Call Logs

Agents

Webhooks

Workspaces

Dispositions

Tasks

SMS