Read a client's onboarding progress
curl --request GET \
--url https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progressimport requests
url = "https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"blocked_on_client": [
"<string>"
],
"complete": true,
"onboarding_id": "<string>",
"plain_language": "<string>",
"step_number": 123,
"test_mode": true,
"total_steps": 123
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"code": "<string>",
"detail": "<string>",
"instance": "<string>"
}Onboarding
Read a client's onboarding progress
Returns a client’s onboarding progress in plain language — which step of how many, and what is currently waiting on the client. Presentation only; it never carries clinical data.
GET
/
v1
/
onboardings
/
{onboarding_id}
/
progress
Read a client's onboarding progress
curl --request GET \
--url https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progressimport requests
url = "https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dev.purplelabelmd.com/v1/onboardings/{onboarding_id}/progress")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"blocked_on_client": [
"<string>"
],
"complete": true,
"onboarding_id": "<string>",
"plain_language": "<string>",
"step_number": 123,
"test_mode": true,
"total_steps": 123
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"code": "<string>",
"detail": "<string>",
"instance": "<string>"
}Path Parameters
Pattern:
^onb_[A-Za-z0-9][A-Za-z0-9_-]*$Response
the client-visible progress
A client's onboarding progress in plain language: which step of how many, what is waiting on the client, and whether this is test mode. Presentation only; it never carries clinical data.