{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"87d290d0-df17-467e-9374-7688a8f1372f","name":"GetVocal Reference API documentation","description":"### **Table of contents:**\n\n> 🪐 Get Started  \n🔐 Authorization  \n✍️ Example Responses  \n🔄 Data flow to call a lead  \n🤔 Need Help? \n  \n\n## 🪐 **Get Started**\n\nSteps to get started with GetVocal's API:\n\n1. **Authorization**: Login using your GetVocal provided username and password to get a JWT token\n    \n2. **Access**: Use a JWT bearer token returned by the `login` route (explained below). Alternatively, you can also create an API Key for your user that will give you access to the same route as your user, but don't need refreshing.\n    \n\nFor more details, check out the additional sections below, and click `View Complete Documentation` for the complete documentation. If you have questions about the folder or request, look for the documentation icon for documentation-in-context.\n\n## 🔐 Authorization\n\n- The GetVocal API uses JWT tokens for authorization, or ApiKeys with Secrets.\n    \n- You must include an access token in each request to the Postman API with the `Authorization` request header (`Bearer: XXX` as the content, replacing XXX with the actual token).\n    \n    - If you're using an API Key, you must set the `X-Client-Api-Key` and `X-Client-Api-Key-Secret` headers.\n        \n- The access token has been pre-filled as a [collection variable](https://learning.postman.com/docs/sending-requests/variables/). The authorization has been set up at the collection level, so all requests in this collection will automatically inherit the needed header.\n    \n\n> ⚠ Don’t leak your secrets! Initial values are saved, and can be shared with others in team workspaces. Current values are local values that are not saved, and won't be persisted in the original shared collection, environment, or globals. [Learn more about variables in Postman](https://learning.postman.com/docs/sending-requests/variables/#initial-and-current-values) \n  \n\n## ✍️ Example Responses\n\nWe have documented many of the possible responses you might encounter using [Examples](https://learning.postman.com/docs/sending-requests/examples/) under each request.\n\n## 🔄 Data flow to call a lead (outbound)\n\nGetvocal's data flow to call a lead has 4 steps:\n\n- Authenticate (JWT or ApiKeys)\n    \n- Create the lead\n    \n- Get the persona id you want to trigger the call with\n    \n- Trigger the call\n    \n- Get the call output\n    \n\nYou can find information on each of these steps in their corresponding folders.\n\n### 🤔 **Need Help?**\n\nThe GetVocal team wants to ensure that your team has everything they need to successfully integrate our services into your applications and services. Don't hesitate to reach out to us at `jules [at] getvocal [dot] ai`\n\n> Is your team utilizing this API in a use case not represented here? We want to know about it! Add a comment with your suggestions and feedback! \n  \n\nYou should have gotten from the GetVocal team a `company_id` and one or more `persona_id` which you will use throughout this documentation","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"38745562","team":6479648,"collectionId":"87d290d0-df17-467e-9374-7688a8f1372f","publishedId":"2sAYQXpDHG","public":true,"publicUrl":"https://api-documentation.getvocal.ai","privateUrl":"https://go.postman.co/documentation/38745562-87d290d0-df17-467e-9374-7688a8f1372f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"764BF8"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"This documentation explains how the GetVocal API works and how you can interact with it"},{"name":"title","value":"GetVocal's API Documentation"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/0102be53-6519-4a6a-b4a1-3a1278878063/TG9nb19Ob3YyNC5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"764BF8"}},{"name":"light","logo":"https://content.pstmn.io/0102be53-6519-4a6a-b4a1-3a1278878063/TG9nb19Ob3YyNC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"764BF8"}}]}},"version":"8.10.1","publishDate":"2025-01-14T19:19:00.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"GetVocal's API Documentation","description":"This documentation explains how the GetVocal API works and how you can interact with it"},"logos":{"logoLight":"https://content.pstmn.io/0102be53-6519-4a6a-b4a1-3a1278878063/TG9nb19Ob3YyNC5wbmc=","logoDark":"https://content.pstmn.io/0102be53-6519-4a6a-b4a1-3a1278878063/TG9nb19Ob3YyNC5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f8255842ef1ea5f9b15c6ca743bc31bfa788fdc8f55f92579756f4e993603d3b","favicon":"https://getvocal.ai/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-documentation.getvocal.ai/view/metadata/2sAYQXpDHG"}