Skip to main content

​
API Overview

The Voxworks API lets you create contacts, schedule calls, retrieve call results, manage lists and objects, and receive inbound automation webhooks.

​
Base URL

All public API endpoints in this reference are under /api/v1.

​
Authentication

Most endpoints require a bearer API key:
Webhook trigger URLs use a token in the path instead. If webhook HMAC signing is configured, include X-Webhook-Signature with the SHA-256 HMAC signature.

​
Content Type

Send JSON request bodies with:

​
Errors

Errors use a consistent JSON shape:
Rate-limited responses return 429 and include Retry-After, X-RateLimit-Limit, and X-RateLimit-Remaining headers.