{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b4391df2-bb09-477a-9ef6-f276e4e75fc7","name":"PUBLIC REST API v2.0.0","description":"# 👇👇👇👇👇👇👇👇👇👇 [CLICK HERE TO WATCH THE API QUICK START VIDEO](https://video.bunnycdn.com/play/90694/35583473-14e0-4246-8584-f823800514f8)\n\n---\n\n# **QUICK SETUP GUIDE - Use a Username + Password to Use the API (Created Bearer Token)**\n\n**Welcome** 😁 The API docs are organized into folders to match the menu navigation of the online web application. If you have any questions please reach out to support. Follow the steps below to connect to the API\n\n### Step 1) Click \"Run in Postman\"\n\n\n\n### Step 2) Under \"Environment\" Change the \"HostURL\".\n\nClick on \"Environment\" on the left side menu and edit the \"Environment\" named \"PUBLIC - LIVE API\" to change the \"Current Value\" of the variables below;\n\n\\* \"**HostURL**\" = Set to the URL you use to login to the online web application. (This is the same URL you will use for the API)\n\n\n\n### Step 3) Authenticate using the \"Login\" API Endpoint.\n\nJust make sure you select the \"Environment\" named \"PUBLIC - LIVE API\" first and then enter your Username and Password in the Request Body.\n\n\n\n### Step 4) Congratulations! You're ready to call any other API's in the Collection.\n\nNow that you called the \"Login\" API we automatically updated your Authorization header using your new Bearer Token. This is all done with Pre-Request Scripts in Postman. No need to do update your Environment Config or anything else. Simply start using any of the API's in Postman!\n\n**Please note your Bearer Token expires after 24 hours. Then you will need to call the** **`/login`** [**API Endpoint**](#93402383-2958-4884-ac76-d9b64455b3c9) **to refresh it again**\n\nFYI: If a users Role or Password is changed, all previously issued tokens are revoked and the user will need to re-login to receive a new Token\n\nAccess to the API's are restricted based on the Role associated with the Key/User just like the online web application.\n\n# QUICK SETUP GUIDE OPTION #2 **\\- Using Public/Private Key Combination for a Server Side API Connection**\n\n**Step 1)** You can create a Public Key & Private Key pair under **Settings > Access Keys**\n\n**Step 2)** Change the Postman \"Environment\" to the sample named \"PUBLIC - LIVE API\" using the dropdown menu on the top right inside the new Collection\n\n**Step 3)** Click on \"Environment\" on the left side menu and edit the \"Environment\" named \"PUBLIC - LIVE API\" to change the \"Current Value\" of the variables below;\n\n\\* \"**HostURL**\" = Set to the URL you use to login to the online web application. (This is the same URL you will use for the API)\n\n\\* **\"public_key\"** = Set to the public_key you generated from Step 1. (Example \"abc123abc123abc123abc1\")\n\n\\* **\"private_key\"** = Set to the public_key you generated from Step 1. (Example \"xzy876xzy876xzy876xzy876xzy876xzy876\")\n\nNow you are ready to start making API calls!\n\n---\n\nAccess to the API's are restricted based on the Role associated with the Key/User just like the online web application.\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17000111","team":2321398,"collectionId":"b4391df2-bb09-477a-9ef6-f276e4e75fc7","publishedId":"UVkjvHWW","public":true,"publicUrl":"https://www.myapidocs.com","privateUrl":"https://go.postman.co/documentation/17000111-b4391df2-bb09-477a-9ef6-f276e4e75fc7","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"79b4fa"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-02-18T17:41:49.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"PUBLIC - LIVE API","id":"3881deb4-b50f-4a45-b268-1e56665e824a","owner":"17000111","values":[{"key":"BearToken","value":"abc123abc123abc123abc123abc123abc123","enabled":true},{"key":"HostURL","value":"https://app.crmconnect.co","enabled":true},{"key":"SessionID","value":"","enabled":true,"type":"default"},{"key":"public_key","value":"","enabled":true,"type":"default"},{"key":"private_key","value":"","enabled":true,"type":"default"}],"published":true}],"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/ca40818a1275f858d9236b97f7f507c392f17ca0ac935954959422a9d0da681a","favicon":"https://myapidocs.com/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"},{"label":"PUBLIC - LIVE API","value":"17000111-3881deb4-b50f-4a45-b268-1e56665e824a"}],"canonicalUrl":"https://www.myapidocs.com/view/metadata/UVkjvHWW"}