Metrics
New patients
Resolves the location from the X-Vendor-Request-Key header (slot); no location_id in the path.
This endpoint retrieves new patient values for a specific location and for a specific duration.
Parameters
- date (required): The reference date representing when the first treatment was performed.
- duration (optional): The time period (in days) to look up data within, starting from the given date.
- q[exam_type_filter] (optional): A parameter to specify the exam type that can be “limited”, “comprehensive” or “periodic”.
- q[exam_provider_id_in] (optional): An array of exam provider IDs to filter the search results.
- q[provider_id_in] (optional): An array of appointments provider IDs to filter the search results.
GET
/
patients
/
new_patients
New patients
curl --request GET \
--url https://api.teamcaredental.com/api/v2/vendors/patients/new_patients \
--header 'Authorization: Bearer <token>' \
--header 'X-Vendor-Request-Key: <api-key>'import requests
url = "https://api.teamcaredental.com/api/v2/vendors/patients/new_patients"
headers = {
"Authorization": "Bearer <token>",
"X-Vendor-Request-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'X-Vendor-Request-Key': '<api-key>'}
};
fetch('https://api.teamcaredental.com/api/v2/vendors/patients/new_patients', 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.teamcaredental.com/api/v2/vendors/patients/new_patients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Vendor-Request-Key: <api-key>"
],
]);
$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.teamcaredental.com/api/v2/vendors/patients/new_patients"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Vendor-Request-Key", "<api-key>")
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.teamcaredental.com/api/v2/vendors/patients/new_patients")
.header("Authorization", "Bearer <token>")
.header("X-Vendor-Request-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamcaredental.com/api/v2/vendors/patients/new_patients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Vendor-Request-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"patients": 0,
"attended_production": 0,
"total": 0,
"30_days_production": 0
}{
"errors": "not authorized"
}{
"errors": "access Denied"
}{
"errors": "resource not found"
}{
"errors": "..."
}Authorizations
JWT returned by POST /auth/token. Valid for six hours.
Request key returned by POST /locations/{location_id}/slots. Identifies the practice for a data request; valid for 6 hours (the access token's lifetime) and subject to the firm's concurrent-slot quota.
Query Parameters
The reference date representing when the first treatment was performed.
Example:
"2023-03-01"
The time period (in days) to look up data within, starting from the given date.
Example:
90
Show child attributes
Show child attributes
⌘I
New patients
curl --request GET \
--url https://api.teamcaredental.com/api/v2/vendors/patients/new_patients \
--header 'Authorization: Bearer <token>' \
--header 'X-Vendor-Request-Key: <api-key>'import requests
url = "https://api.teamcaredental.com/api/v2/vendors/patients/new_patients"
headers = {
"Authorization": "Bearer <token>",
"X-Vendor-Request-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'X-Vendor-Request-Key': '<api-key>'}
};
fetch('https://api.teamcaredental.com/api/v2/vendors/patients/new_patients', 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.teamcaredental.com/api/v2/vendors/patients/new_patients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-Vendor-Request-Key: <api-key>"
],
]);
$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.teamcaredental.com/api/v2/vendors/patients/new_patients"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Vendor-Request-Key", "<api-key>")
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.teamcaredental.com/api/v2/vendors/patients/new_patients")
.header("Authorization", "Bearer <token>")
.header("X-Vendor-Request-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamcaredental.com/api/v2/vendors/patients/new_patients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Vendor-Request-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"patients": 0,
"attended_production": 0,
"total": 0,
"30_days_production": 0
}{
"errors": "not authorized"
}{
"errors": "access Denied"
}{
"errors": "resource not found"
}{
"errors": "..."
}