Authenticate, send requests, handle errors, and use the Voxworks public API reference.
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
https://api.voxworks.ai
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:
Authorization: Bearer YOUR_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:
Content-Type: application/json
Errors
Errors use a consistent JSON shape:
{ "success": false, "message": "Invalid API key"}
Rate-limited responses return 429 and include Retry-After, X-RateLimit-Limit, and X-RateLimit-Remaining headers.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Voxworks","colors":{"primary":"#526FFB","light":"#7084FC","dark":"#2B5BFA"},"logo":{"light":"https://mintcdn.com/voxworks/KU6-tR1KJSXioHJ9/images/voxworks-docs-light.png?fit=max\u0026auto=format\u0026n=KU6-tR1KJSXioHJ9\u0026q=85\u0026s=9962f31765b8d57bab5a98a8f09fe8a0","dark":"https://mintcdn.com/voxworks/KU6-tR1KJSXioHJ9/images/voxworks-docs-dark.png?fit=max\u0026auto=format\u0026n=KU6-tR1KJSXioHJ9\u0026q=85\u0026s=9a7fd64f96a007a37c8d55c4fe42690a"},"favicon":"https://mintcdn.com/voxworks/xcnzfUN_HbwkLO8s/images/voxworks-favicon.webp?fit=max\u0026auto=format\u0026n=xcnzfUN_HbwkLO8s\u0026q=85\u0026s=21d53d71cd4ed143d2334591d79ecf03","api":{"playground":{"display":"interactive","proxy":true},"examples":{"languages":["curl","javascript","python"]}},"appearance":{"default":"system"},"background":{"color":{"light":"#FFFFFF","dark":"#0A0A0A"}},"navbar":{"links":[{"href":"https://voxworks.ai","label":"Home"},{"href":"https://voxworks.ai/contact","label":"Support"}],"primary":{"type":"button","label":"Login","href":"https://app.voxworks.ai"}},"fonts":{"family":"Geist"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"voxworks","hasAudioNarration":false,"actualSubdomain":"voxworks","customDomains":["docs.voxworks.ai"],"gitSource":{"type":"github","owner":"voxworks-ai","repo":"voxworks-docs","deployBranch":"develop","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af669e09cd661bf040ff5ee","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Documentation","count":167},{"language":"default","tag":"Tools, Automations \u0026 Integrations","count":58},{"language":"default","tag":"Get Started \u0026 Build","count":48},{"language":"default","tag":"Surveys","count":37},{"language":"default","tag":"API Reference","count":35},{"language":"default","tag":"Endpoints","count":29},{"language":"default","tag":"Calls, Contacts \u0026 Batches","count":28},{"language":"default","tag":"Account, Billing \u0026 Security","count":20},{"language":"default","tag":"Calls","count":17},{"language":"default","tag":"Numbers \u0026 Routing","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--vox-brand-50: #f5f6ff;--vox-brand-100: #e8eafe;--vox-brand-200: #d0d5fe;--vox-brand-300: #bcc3fd;--vox-brand-400: #a4aefd;--vox-brand-500: #8b99fc;--vox-brand-600: #7084fc;--vox-brand-700: #526ffb;--vox-brand-800: #2b5bfa;--vox-brand-900: #072c8e;--vox-brand-950: #021754;--vox-blue-50: #effaff;--vox-blue-100: #daf2ff;--vox-blue-200: #beafff;--vox-blue-300: #91deff;--vox-blue-400: #5dc9fd;--vox-blue-500: #37adfa;--vox-blue-600: #2c96f0;--vox-blue-700: #1978dc;--vox-blue-800: #1b60b2;--vox-blue-900: #1c538c;--vox-blue-950: #163255;--vox-slate-50: #f8fafc;--vox-slate-100: #f1f5f9;--vox-slate-200: #e2e8f0;--vox-slate-300: #cbd5e1;--vox-slate-400: #94a3b8;--vox-slate-500: #64748b;--vox-slate-600: #475569;--vox-slate-700: #334155;--vox-slate-800: #1e293b;--vox-slate-900: #0f172a}::selection{background:rgb(82 111 251 / 18%)}#navbar img[src*=\"voxworks-docs\"]{height:40px!important;max-height:40px!important;width:auto!important}@media (max-width: 768px){#navbar img[src*=\"voxworks-docs\"]{height:34px!important;max-height:34px!important}}"}],"page":{"pagePath":"api-reference/overview","slug":"/api-reference/overview","pageMetadata":{"title":"API Overview","description":"Authenticate, send requests, handle errors, and use the Voxworks public API reference.","href":"/api-reference/overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Authenticate, send requests, handle errors, and use the Voxworks public API reference.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`api-overview`,children:`API Overview`}),`\n`,_jsx(_components.p,{children:`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.`}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.voxworks.ai`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`All public API endpoints in this reference are under `,_jsx(_components.code,{children:`/api/v1`}),`.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`The Lists endpoints now live under `,_jsx(_components.code,{children:`/api/v1/lists`}),`: for example `,_jsx(_components.code,{children:`POST /api/v1/lists`}),` creates a list and `,_jsx(_components.code,{children:`POST /api/v1/lists/{list_id}/contacts`}),` adds contacts to one. The older paths (`,_jsx(_components.code,{children:`/api/v1/get-list/…`}),`, `,_jsx(_components.code,{children:`/api/v1/create-list`}),`, `,_jsx(_components.code,{children:`/api/v1/edit-list/…`}),`, `,_jsx(_components.code,{children:`/api/v1/delete-list/…`}),`, `,_jsx(_components.code,{children:`/api/v1/add-existing-contacts-to-list/…`}),`, `,_jsx(_components.code,{children:`/api/v1/add-contacts-to-list/…`}),`, `,_jsx(_components.code,{children:`/api/v1/delete-contacts-from-list/…`}),` and their singular forms) return `,_jsx(_components.code,{children:`404`}),`. Request and response bodies are unchanged.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`Most endpoints require a bearer API key:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Authorization`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer YOUR_API_KEY`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Webhook trigger URLs use a token in the path instead. If webhook HMAC signing is configured, include `,_jsx(_components.code,{children:`X-Webhook-Signature`}),` with the SHA-256 HMAC signature.`]}),`\n`,_jsx(Heading,{level:`2`,id:`content-type`,children:`Content Type`}),`\n`,_jsx(_components.p,{children:`Send JSON request bodies with:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Content-Type`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` application/json`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsx(_components.p,{children:`Errors use a consistent JSON shape:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Invalid API key\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Rate-limited responses return `,_jsx(_components.code,{children:`429`}),` and include `,_jsx(_components.code,{children:`Retry-After`}),`, `,_jsx(_components.code,{children:`X-RateLimit-Limit`}),`, and `,_jsx(_components.code,{children:`X-RateLimit-Remaining`}),` headers.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API Overview","description":"Authenticate, send requests, handle errors, and use the Voxworks public API reference.","href":"/api-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"API Overview","slug":"api-overview","depth":1,"children":[]},{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Content Type","slug":"content-type","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"voxworks","siteName":"Voxworks","title":"API Overview - Voxworks","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-25T05:26:28.045Z","originalFileLocation":"api-reference/overview.md"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Authenticate, send requests, handle errors, and use the Voxworks public API reference.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Voxworks\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Overview - Voxworks\">\u003cmeta data-mint-head property=\"og:description\" content=\"Authenticate, send requests, handle errors, and use the Voxworks public API reference.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Voxworks\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.voxworks.ai/api-reference/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://voxworks.mintlify.site/_mintlify/api/og/v2?division=API+Basics\u0026amp;title=API+Overview\u0026amp;description=Authenticate%2C+send+requests%2C+handle+errors%2C+and+use+the+Voxworks+public+API+reference.\u0026amp;theme=c3ce9d6b7615953069414f4f\u0026amp;signature=43213c4150dbf38c15f8445c1e0654ebe458e87a632ce3f33746639bfa7cd158\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API Overview - Voxworks\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Authenticate, send requests, handle errors, and use the Voxworks public API reference.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://voxworks.mintlify.site/_mintlify/api/og/v2?division=API+Basics\u0026amp;title=API+Overview\u0026amp;description=Authenticate%2C+send+requests%2C+handle+errors%2C+and+use+the+Voxworks+public+API+reference.\u0026amp;theme=c3ce9d6b7615953069414f4f\u0026amp;signature=43213c4150dbf38c15f8445c1e0654ebe458e87a632ce3f33746639bfa7cd158\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/voxworks/sDm7UkXPyZDrMcuF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Voxworks\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#526FFB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.voxworks.ai/api-reference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.voxworks.ai/#organization\",\"name\":\"Voxworks\",\"url\":\"https://docs.voxworks.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/voxworks/KU6-tR1KJSXioHJ9/images/voxworks-docs-light.png?fit=max\u0026auto=format\u0026n=KU6-tR1KJSXioHJ9\u0026q=85\u0026s=9962f31765b8d57bab5a98a8f09fe8a0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.voxworks.ai#website\",\"name\":\"Voxworks\",\"url\":\"https://docs.voxworks.ai\",\"publisher\":{\"@id\":\"https://docs.voxworks.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.voxworks.ai/api-reference/overview#webpage\",\"url\":\"https://docs.voxworks.ai/api-reference/overview\",\"name\":\"API Overview\",\"description\":\"Authenticate, send requests, handle errors, and use the Voxworks public API reference.\",\"dateModified\":\"2026-09-25T05:26:28.045Z\",\"isPartOf\":{\"@id\":\"https://docs.voxworks.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.voxworks.ai/api-reference/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.voxworks.ai/api-reference/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Voxworks\",\"item\":\"https://docs.voxworks.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Overview\",\"item\":\"https://docs.voxworks.ai/api-reference/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.voxworks.ai/api-reference/overview#article\",\"headline\":\"API Overview\",\"name\":\"API Overview\",\"description\":\"Authenticate, send requests, handle errors, and use the Voxworks public API reference.\",\"url\":\"https://docs.voxworks.ai/api-reference/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.voxworks.ai/api-reference/overview#webpage\"},\"dateModified\":\"2026-09-25T05:26:28.045Z\",\"publisher\":{\"@id\":\"https://docs.voxworks.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.voxworks.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Voxworks\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Voxworks\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/overview.md","siteName":"Voxworks","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"Surveys","icon":"square-poll-vertical","pages":[{"title":"Surveys","href":"/surveys/overview"}]},{"tab":"MCP Connector","icon":"plug","pages":[{"title":"MCP Connector","href":"/mcp/overview"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"API Basics","pages":[{"title":"API Overview","href":"/api-reference/overview"},{"title":"API Keys \u0026 Authentication","description":"Generate, use, and manage the API keys that authenticate requests to the Voxworks API, plus the exact error responses to expect.","href":"/api-reference/authentication"},{"title":"API Quickstart","href":"/api-reference/quickstart"},{"title":"Embedded Web Calls","href":"/api-reference/embedded-web-calls"},{"title":"Rate Limits \u0026 Request Limits","href":"/api-reference/rate-limits"},{"title":"Receiving Webhooks from Voxworks","href":"/api-reference/receiving-webhooks"}]},{"group":"Endpoints","pages":[{"group":"Health","expanded":false,"pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/health","href":"/api-reference/health/health-check"}]},{"group":"Contacts","expanded":false,"pages":[{"title":"Create contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/create-contact","href":"/api-reference/contacts/create-contact"},{"title":"Get contact by phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/get-contact/{phone_number}","href":"/api-reference/contacts/get-contact-by-phone-number"}]},{"group":"Calls","expanded":false,"pages":[{"title":"Create phone call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/create-phone-call","href":"/api-reference/calls/create-phone-call"},{"title":"Create web session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/create-web-session","href":"/api-reference/calls/create-web-session"},{"title":"List calls","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/calls","href":"/api-reference/calls/list-calls"},{"title":"Get call","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/get-call/{call_id}","href":"/api-reference/calls/get-call"},{"title":"Get call status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/get-call-status/{call_id}","href":"/api-reference/calls/get-call-status"},{"title":"Get call result","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/get-call-result/{call_id}","href":"/api-reference/calls/get-call-result"},{"title":"Cancel call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/cancel-call/{call_id}","href":"/api-reference/calls/cancel-call"},{"title":"Reschedule call","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/reschedule-call/{call_id}","href":"/api-reference/calls/reschedule-call"},{"title":"Retry call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/retry-call/{call_id}","href":"/api-reference/calls/retry-call"}]},{"group":"Lists","expanded":false,"pages":[{"title":"List lists","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/lists","href":"/api-reference/lists/list-lists"},{"title":"Create list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/lists","href":"/api-reference/lists/create-list"},{"title":"Get list","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/lists/{list_id}","href":"/api-reference/lists/get-list"},{"title":"Edit list","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api/v1/lists/{list_id}","href":"/api-reference/lists/edit-list"},{"title":"Delete list","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/lists/{list_id}","href":"/api-reference/lists/delete-list"},{"title":"Add existing contacts to list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/lists/{list_id}/contacts/existing","href":"/api-reference/lists/add-existing-contacts-to-list"},{"title":"Create or add contacts to list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/lists/{list_id}/contacts","href":"/api-reference/lists/create-or-add-contacts-to-list"},{"title":"Remove contacts from list","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/lists/{list_id}/contacts","href":"/api-reference/lists/remove-contacts-from-list"}]},{"group":"Custom Variables","expanded":false,"pages":[{"title":"List object types","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/object-types","href":"/api-reference/objects/list-object-types"},{"title":"Create object type","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/object-types","href":"/api-reference/objects/create-object-type"},{"title":"Get object type by ID","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/object-types/{object_type_id}","href":"/api-reference/objects/get-object-type-by-id"},{"title":"Get object type by name","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api/v1/object-types/by-name/{type_name}","href":"/api-reference/objects/get-object-type-by-name"},{"title":"Create object","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/create-object","href":"/api-reference/objects/create-object"},{"title":"Upsert object","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/upsert-object","href":"/api-reference/objects/upsert-object"},{"title":"Delete object","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api/v1/delete-object/{object_id}","href":"/api-reference/objects/delete-object"},{"title":"Link contact to object","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/link-contact-to-object/{object_id}","href":"/api-reference/objects/link-contact-to-object"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Trigger automation webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api/v1/hooks/{token}","href":"/api-reference/webhooks/trigger-automation-webhook"}]}]}]},{"tab":"Updates","icon":"sparkles","pages":[{"title":"Updates","href":"/updates/overview"}]}]},"basePath":"","title":"API Overview - Voxworks","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":[],"chunks":[]}