Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.dialbird.io/llms.txt

Use this file to discover all available pages before exploring further.

The Dialbird Public API is a versioned, machine-to-machine REST surface for building automations on top of Dialbird — from no-code tools like Zapier, n8n, and Make to custom scripts and backend services.

Base URL

All endpoints live under the versioned /api/v1 path:
https://api.dialbird.com/api/v1

What you can do

Manage contacts

Create and update contacts in your business with the same match-and-merge behavior as the app.

Send SMS

Queue outbound text messages and track delivery through webhooks.

Subscribe to events

Receive signed webhook deliveries for inbound/outbound messages and completed calls.

Verify identity

Resolve the business, user, and scopes behind an access token with GET /me.

How requests work

  • Authentication — Every endpoint except GET /health requires an OAuth 2.0 bearer token. See Authentication.
  • JSON, snake_case — All request and response bodies are JSON with snake_case fields. See Conventions.
  • Safe retries — Write endpoints accept an Idempotency-Key. See Idempotency.
  • Predictable errors — Every error shares one envelope with a stable code. See Errors and rate limits.

Next steps

Authenticate

Obtain an access token via the OAuth 2.0 Authorization Code flow.

Quickstart

Confirm your token, send your first SMS, and subscribe to an event.