> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ondial.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# All endpoints

> Every /api/v1 endpoint at a glance, grouped by area.

**53 endpoints** · Base URL `https://dashboard.ondial.ai` · Auth `Authorization: Bearer ond_live_…` (or `ond_test_…` for test mode).

> **[Create a lead](https://docs.ondial.ai/get-started/guides/push-leads.md)**
>
> Push one lead and start the call, WhatsApp or email.

> **[Bulk leads](https://docs.ondial.ai/get-started/guides/bulk-leads.md)**
>
> Send many leads in one request.

> **[Webhooks](https://docs.ondial.ai/api-reference/endpoint/webhooks/manage-webhooks.md)**
>
> Get call status and analysis pushed to you.

> **[Errors](https://docs.ondial.ai/api-reference/quick-start/errors.md)**
>
> Every reasonCode and what to do.

> **[Authentication](https://docs.ondial.ai/api-reference/quick-start/authentication.md)**
>
> API keys, test mode, scopes.

> **[Quick start](https://docs.ondial.ai/api-reference/quick-start/guide.md)**
>
> Ping, templates, first lead.

## Set up and test

Check your key and see which templates you can use.

| Method | Endpoint | What it does |
| - | - | - |
| GET | [`/ping`](https://docs.ondial.ai/api-reference/endpoint/core/ping) | Auth check |
| GET | [`/omni/templates`](https://docs.ondial.ai/api-reference/endpoint/core/list-omni-templates) | List Omni templates |

## Send leads

Find a campaign, check its lead setup, validate, then create one lead or many.

| Method | Endpoint | What it does |
| - | - | - |
| GET | [`/campaigns`](https://docs.ondial.ai/api-reference/endpoint/outbound/list-campaigns) | List outbound campaigns |
| GET | [`/campaigns/{campaignId}`](https://docs.ondial.ai/api-reference/endpoint/outbound/get-campaign) | Get campaign |
| GET | [`/campaigns/{campaignId}/lead-setup`](https://docs.ondial.ai/api-reference/endpoint/outbound/lead-setup) | Lead setup for a campaign |
| POST | [`/leads/validate`](https://docs.ondial.ai/api-reference/endpoint/outbound/validate-lead) | Validate lead (dry run) |
| POST | [`/leads`](https://docs.ondial.ai/api-reference/endpoint/core/create-lead) | Create lead |
| POST | [`/leads/bulk`](https://docs.ondial.ai/api-reference/endpoint/core/create-leads-bulk) | Create leads in bulk |
| GET | [`/campaigns/{campaignId}/contacts`](https://docs.ondial.ai/api-reference/endpoint/contacts/list-campaign-contacts) | List campaign contacts |

## Track contacts

What happened to a lead: status, calls, follow-ups, cancel or delete.

| Method | Endpoint | What it does |
| - | - | - |
| GET | [`/contacts/{id}`](https://docs.ondial.ai/api-reference/endpoint/contacts/get-contact) | Get contact status |
| GET | [`/contacts/{id}/calls`](https://docs.ondial.ai/api-reference/endpoint/contacts/list-contact-calls) | List dial attempts for a contact |
| GET | [`/contacts/{id}/calls/{callId}`](https://docs.ondial.ai/api-reference/endpoint/contacts/get-contact-call) | Get dial conversation + analysis |
| POST | [`/contacts/{id}/followups`](https://docs.ondial.ai/api-reference/endpoint/contacts/schedule-followup) | Schedule follow-up |
| POST | [`/contacts/{id}/cancel`](https://docs.ondial.ai/api-reference/endpoint/contacts/cancel-contact) | Cancel queued dial/send/follow-up |
| DELETE | [`/contacts/{id}`](https://docs.ondial.ai/api-reference/endpoint/contacts/delete-contact) | Soft-delete contact |

## Calls and recordings

Live and finished calls, details and signed recording links.

| Method | Endpoint | What it does |
| - | - | - |
| GET | [`/calls`](https://docs.ondial.ai/api-reference/endpoint/calls/list-calls) | List unified calls |
| GET | [`/calls/active`](https://docs.ondial.ai/api-reference/endpoint/calls/list-active-calls) | List active calls |
| GET | [`/calls/{id}`](https://docs.ondial.ai/api-reference/endpoint/calls/get-call) | Get call detail |
| GET | [`/calls/{id}/recording`](https://docs.ondial.ai/api-reference/endpoint/calls/get-call-recording) | Get signed recording URL |

## Webhooks

Get call and lead events pushed to your system.

| Method | Endpoint | What it does |
| - | - | - |
| GET | [`/webhooks`](https://docs.ondial.ai/api-reference/endpoint/webhooks/manage-webhooks) | List tenant webhooks |
| POST | [`/webhooks`](https://docs.ondial.ai/api-reference/endpoint/webhooks/manage-webhooks) | Create or manage webhook |
| PATCH | [`/webhooks`](https://docs.ondial.ai/api-reference/endpoint/webhooks/manage-webhooks) | Update webhook |
| DELETE | [`/webhooks`](https://docs.ondial.ai/api-reference/endpoint/webhooks/manage-webhooks) | Delete webhook |

## Events

Map your own events to campaigns.

| Method | Endpoint | What it does |
| - | - | - |
| POST | [`/events`](https://docs.ondial.ai/api-reference/endpoint/events/post-event) | ERP event → mapped campaign |
| GET | [`/event-routes`](https://docs.ondial.ai/api-reference/endpoint/events/list-event-routes) | List event routes |
| POST | [`/event-routes`](https://docs.ondial.ai/api-reference/endpoint/events/upsert-event-route) | Upsert event route |
| DELETE | [`/event-routes`](https://docs.ondial.ai/api-reference/endpoint/events/delete-event-route) | Delete event route |

## Credits and analytics

Wallet balance, credit history and call reports.

| Method | Endpoint | What it does |
| - | - | - |
| GET | [`/credits`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/get-credits) | Get credit balance |
| GET | [`/credits/transactions`](https://docs.ondial.ai/api-reference/endpoint/credits/list-credit-transactions) | List credit transactions |
| GET | [`/analytics/calls`](https://docs.ondial.ai/api-reference/endpoint/analytics/get-call-analytics) | Call analytics aggregates |

## Inbound agents

Create and manage agents that answer calls.

| Method | Endpoint | What it does |
| - | - | - |
| GET | [`/inbound-agents`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/list-inbound-agents) | List inbound agents |
| POST | [`/inbound-agents`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/create-inbound-agent) | Create inbound agent on owned number |
| GET | [`/inbound-agents/{id}`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/get-inbound-agent) | Get inbound agent |
| PATCH | [`/inbound-agents/{id}`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/update-inbound-agent) | Update inbound agent |
| POST | [`/inbound-agents/{id}/generate-script`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/generate-inbound-script) | Generate inbound agent script |
| POST | [`/inbound-agents/{id}/activate`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/activate-inbound-agent) | Activate or deactivate inbound agent |
| POST | [`/inbound-agents/{id}/sync-doctors`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/sync-inbound-doctors) | Sync HMS doctors onto inbound agent |
| POST | [`/inbound-agents/{id}/crm/lookup`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/inbound-crm-lookup) | CRM lookup for inbound agent |
| DELETE | [`/inbound-agents/{id}`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/delete-inbound-agent) | Delete inbound agent |

## Numbers and voices

Voices, the numbers you own and numbers you can buy.

| Method | Endpoint | What it does |
| - | - | - |
| GET | [`/voices`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/list-voices) | List TTS voices |
| GET | [`/numbers`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/list-owned-numbers) | List owned phone numbers |
| GET | [`/numbers/available`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/list-available-numbers) | List available pool numbers |
| POST | [`/numbers/purchase`](https://docs.ondial.ai/api-reference/endpoint/inbound-agents/purchase-numbers) | Purchase pool numbers |

## Companies

Company profiles used by campaigns and agents.

| Method | Endpoint | What it does |
| - | - | - |
| GET | [`/companies`](https://docs.ondial.ai/api-reference/endpoint/companies/list-companies) | List company profiles |
| POST | [`/companies`](https://docs.ondial.ai/api-reference/endpoint/companies/create-company) | Create company profile |
| GET | [`/companies/{id}`](https://docs.ondial.ai/api-reference/endpoint/companies/get-company) | Get company profile |
| PATCH | [`/companies/{id}`](https://docs.ondial.ai/api-reference/endpoint/companies/update-company) | Update company profile |
| DELETE | [`/companies/{id}`](https://docs.ondial.ai/api-reference/endpoint/companies/delete-company) | Delete company profile |

## Knowledge bases

Documents your agents can use.

| Method | Endpoint | What it does |
| - | - | - |
| GET | [`/knowledge-bases/documents`](https://docs.ondial.ai/api-reference/endpoint/knowledge-bases/list-documents) | List knowledge documents |
| GET | [`/knowledge-bases/upload-billing-info`](https://docs.ondial.ai/api-reference/endpoint/knowledge-bases/upload-billing-info) | Knowledge upload billing preview |
| POST | [`/knowledge-bases/documents`](https://docs.ondial.ai/api-reference/endpoint/knowledge-bases/upload-document) | Upload knowledge document |
| GET | [`/knowledge-bases/documents/{fileId}`](https://docs.ondial.ai/api-reference/endpoint/knowledge-bases/get-document) | Get document metadata |
| DELETE | [`/knowledge-bases/documents/{fileId}`](https://docs.ondial.ai/api-reference/endpoint/knowledge-bases/delete-document) | Delete knowledge document |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.