{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"37015359-b0a8-447e-97af-528ae2f8739f","name":"Alluvium API","description":"## **Welcome to Alluvium**\n\nThis site contains technical documentation for Alluvium's APIs, including\n\n- FHIR APIs\n    \n- Alluvium APIs (_proprietary APIs created to empower our clients_)\n    \n- APIs\n    \n\nThe technical specifications provide details on embeddable APIs as well as sample requests & responses. It is not specific to any particular electronic health record system and is  \ndesigned to be a universal, EHR-agnostic API for scheduling appointments.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"30058409","team":3897477,"collectionId":"37015359-b0a8-447e-97af-528ae2f8739f","publishedId":"2sBXcBkgcG","public":true,"publicUrl":"https://docs.alluviumhealth.com","privateUrl":"https://go.postman.co/documentation/30058409-37015359-b0a8-447e-97af-528ae2f8739f","customColor":{"top-bar":"362020","right-sidebar":"3D3839","highlight":"573B3B"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/41c320ac-d6a9-4104-a9cf-536588d5b5dc/QWxsdXZpdW0tUHJpbWFyeUxvZ28tV2hpdGUucG5n","colors":{"top-bar":"362020","right-sidebar":"3D3839","highlight":"F2E9E9"}},{"name":"light","logo":"https://content.pstmn.io/6ac91ac7-6344-4656-a4b5-b890385d2eea/QWxsdXZpdW0tUHJpbWFyeUxvZ28tV2hpdGUucG5n","colors":{"top-bar":"362020","right-sidebar":"3D3839","highlight":"573B3B"}}]}},"version":"8.10.1","publishDate":"2026-02-23T16:45:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/6ac91ac7-6344-4656-a4b5-b890385d2eea/QWxsdXZpdW0tUHJpbWFyeUxvZ28tV2hpdGUucG5n","logoDark":"https://content.pstmn.io/41c320ac-d6a9-4104-a9cf-536588d5b5dc/QWxsdXZpdW0tUHJpbWFyeUxvZ28tV2hpdGUucG5n"}},"statusCode":200},"environments":[{"name":"Alluvium Sample Org","id":"605ac9fb-e7fb-43fd-b4bc-e28f71a80e06","owner":"30058409","values":[{"key":"baseUrl","value":"https://api.alluviumhealth.com","enabled":true,"type":"default"},{"key":"clientUrl","value":"https://summer-lake-3018.bookappt.link","enabled":true,"type":"default"},{"key":"client_id","value":"","enabled":true,"type":"default"},{"key":"alluvium_api_token","value":"","enabled":true,"type":"secret"},{"key":"hl7_username","value":"","enabled":true,"type":"default"},{"key":"hl7_password","value":"","enabled":true,"type":"default"},{"key":"webhook_id","value":"","enabled":true,"type":"default"},{"key":"referral_id","value":"","enabled":true,"type":"default"},{"key":"appointment_id","value":"","enabled":true,"type":"default"},{"key":"old_appointment_id","value":"","enabled":true,"type":"default"},{"key":"specialty_id","value":"","enabled":true,"type":"default"},{"key":"specialty_display","value":"","enabled":true,"type":"default"},{"key":"visit_type_id","value":"","enabled":true,"type":"default"},{"key":"visit_type_display","value":"","enabled":true,"type":"default"},{"key":"organization_id","value":"your_organization_id","enabled":true,"type":"default"},{"key":"org_id","value":"","enabled":true,"type":"default"},{"key":"location_id","value":"","enabled":true,"type":"default"},{"key":"patient_id","value":"","enabled":true,"type":"default"},{"key":"payor_id","value":"","enabled":true,"type":"default"},{"key":"workflow_queue_id","value":"","enabled":true,"type":"default"},{"key":"task_id","value":"","enabled":true,"type":"default"},{"key":"schedule_id","value":"","enabled":true,"type":"any"},{"key":"profile_id","value":"","enabled":true,"type":"default"},{"key":"slot_id","value":"","enabled":true,"type":"default"},{"key":"dynamic_slot_buffer_id","value":"","enabled":true,"type":"default"},{"key":"provider_id","value":"","enabled":true,"type":"any"},{"key":"org_payor_id","value":"","enabled":true,"type":"default"},{"key":"plan_id","value":"","enabled":true,"type":"any"},{"key":"global_payor_id","value":"","enabled":true,"type":"any"}],"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/1f1dec97ab3db19cdcf8ffbdc003c835efe03d61d08d40ebe27e65bfa963c367","favicon":"https://alluviumhealth.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":"Alluvium Sample Org","value":"30058409-605ac9fb-e7fb-43fd-b4bc-e28f71a80e06"}],"canonicalUrl":"https://docs.alluviumhealth.com/view/metadata/2sBXcBkgcG"}