API Overview
The Voxworks API lets you create contacts, schedule calls, retrieve call results, manage lists and custom variables (called objects in the API), and receive inbound automation webhooks.
Base URL
All public API endpoints in this reference are under /api/v1.
The Lists endpoints now live under /api/v1/lists: for example POST /api/v1/lists creates a list and POST /api/v1/lists/{list_id}/contacts adds contacts to one. The older paths (/api/v1/get-list/…, /api/v1/create-list, /api/v1/edit-list/…, /api/v1/delete-list/…, /api/v1/add-existing-contacts-to-list/…, /api/v1/add-contacts-to-list/…, /api/v1/delete-contacts-from-list/… and their singular forms) return 404. Request and response bodies are unchanged.
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.
