API Endpoints

Complete reference of all available API endpoints for numbers, call flows, calls, billing, and more.

Numbers

Manage your tracking numbers programmatically.

shell
GET    /api/v1/numbers              # List all numbers
POST   /api/v1/numbers/search       # Search available numbers by area code
POST   /api/v1/numbers/purchase      # Purchase a number
PATCH  /api/v1/numbers/:id          # Update a number (assign call flow, etc.)
DELETE /api/v1/numbers/:id          # Release a number

Call Flows

Create and manage call routing configurations.

shell
GET    /api/v1/call-flows            # List all call flows
POST   /api/v1/call-flows            # Create a new call flow
GET    /api/v1/call-flows/:id        # Get call flow details
PUT    /api/v1/call-flows/:id        # Update a call flow
DELETE /api/v1/call-flows/:id        # Delete a call flow

Calls

Access call logs, recordings, and transcriptions.

shell
GET  /api/v1/calls                   # List calls (supports filters)
GET  /api/v1/calls/:id               # Get call details
GET  /api/v1/calls/:id/recording     # Download call recording
GET  /api/v1/calls/:id/transcription # Get AI transcription

Number Pools

Manage DNI number pools.

shell
GET    /api/v1/number-pools          # List pools
POST   /api/v1/number-pools          # Create a pool
GET    /api/v1/number-pools/:id      # Get pool details
PUT    /api/v1/number-pools/:id      # Update a pool
DELETE /api/v1/number-pools/:id      # Delete a pool

Conversations (SMS)

Send and receive text messages.

shell
GET    /api/v1/conversations         # List conversations
POST   /api/v1/sms/send              # Send a text message
GET    /api/v1/conversations/:id     # Get conversation messages

Forms

Access form submission data.

shell
GET  /api/v1/forms/submissions        # List form submissions
GET  /api/v1/forms/settings           # Get form tracking settings
PUT  /api/v1/forms/settings           # Update form tracking settings

Billing

Manage balance and billing.

shell
GET  /api/v1/billing/balance          # Get current balance
POST /api/v1/billing/add-funds       # Add funds to balance
GET  /api/v1/billing/invoices        # List billing history

Users

Manage team members.

shell
GET    /api/v1/users                  # List team members
POST   /api/v1/users                  # Add a user
PATCH  /api/v1/users/:id             # Update user role
DELETE /api/v1/users/:id             # Remove a user