curl --request GET \
--url https://api.usecobalt.com/v1/documents \
--header 'access_token: <api-key>' \
--header 'client_id: <api-key>' \
--header 'client_secret: <api-key>'import requests
url = "https://api.usecobalt.com/v1/documents"
headers = {
"client_id": "<api-key>",
"client_secret": "<api-key>",
"access_token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {client_id: '<api-key>', client_secret: '<api-key>', access_token: '<api-key>'}
};
fetch('https://api.usecobalt.com/v1/documents', 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.usecobalt.com/v1/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"access_token: <api-key>",
"client_id: <api-key>",
"client_secret: <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.usecobalt.com/v1/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("client_id", "<api-key>")
req.Header.Add("client_secret", "<api-key>")
req.Header.Add("access_token", "<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.usecobalt.com/v1/documents")
.header("client_id", "<api-key>")
.header("client_secret", "<api-key>")
.header("access_token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecobalt.com/v1/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["client_id"] = '<api-key>'
request["client_secret"] = '<api-key>'
request["access_token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"documents": [
{
"id": "<string>",
"file_name": "<string>",
"description": "<string>",
"mime_type": "<string>",
"document_type": "file",
"patient_mrn": "<string>",
"patient_ehr_id": "<string>",
"encounter_ehr_id": "<string>",
"folder_ehr_id": "<string>",
"folder_name": "<string>",
"assigned_to_ehr_id": "<string>",
"assigned_to_name": "<string>",
"review_required": true,
"is_high_priority": true,
"tags": [
"<string>"
],
"scanned_date": "<string>",
"service_date": "<string>",
"has_file": true,
"created_at": "<string>",
"updated_at": "<string>"
}
],
"pagination": {
"page": 123,
"page_size": 123,
"total_count": 123,
"total_pages": 123
}
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}List Documents
List stored documents, filtered by date, assignee, folder and more.
curl --request GET \
--url https://api.usecobalt.com/v1/documents \
--header 'access_token: <api-key>' \
--header 'client_id: <api-key>' \
--header 'client_secret: <api-key>'import requests
url = "https://api.usecobalt.com/v1/documents"
headers = {
"client_id": "<api-key>",
"client_secret": "<api-key>",
"access_token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {client_id: '<api-key>', client_secret: '<api-key>', access_token: '<api-key>'}
};
fetch('https://api.usecobalt.com/v1/documents', 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.usecobalt.com/v1/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"access_token: <api-key>",
"client_id: <api-key>",
"client_secret: <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.usecobalt.com/v1/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("client_id", "<api-key>")
req.Header.Add("client_secret", "<api-key>")
req.Header.Add("access_token", "<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.usecobalt.com/v1/documents")
.header("client_id", "<api-key>")
.header("client_secret", "<api-key>")
.header("access_token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usecobalt.com/v1/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["client_id"] = '<api-key>'
request["client_secret"] = '<api-key>'
request["access_token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"documents": [
{
"id": "<string>",
"file_name": "<string>",
"description": "<string>",
"mime_type": "<string>",
"document_type": "file",
"patient_mrn": "<string>",
"patient_ehr_id": "<string>",
"encounter_ehr_id": "<string>",
"folder_ehr_id": "<string>",
"folder_name": "<string>",
"assigned_to_ehr_id": "<string>",
"assigned_to_name": "<string>",
"review_required": true,
"is_high_priority": true,
"tags": [
"<string>"
],
"scanned_date": "<string>",
"service_date": "<string>",
"has_file": true,
"created_at": "<string>",
"updated_at": "<string>"
}
],
"pagination": {
"page": 123,
"page_size": 123,
"total_count": 123,
"total_pages": 123
}
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}has_file is false,
request it first with POST /documents/fetch.
Query Parameters
- start_date (string, required): Start of the date range (YYYY-MM-DD). Matches the EHR scan date for inbox documents, otherwise the day Cobalt stored the document.
- end_date (string, required): End of the date range (YYYY-MM-DD, inclusive).
- inbox (string, optional):
truefor only documents synced from the EHR document inbox,falseto exclude them. - assigned_to_ehr_id (string, optional): Assignee’s staff
ehr_idfrom GET /staff. - assigned_to_name (string, optional): Assignee name as shown in the EHR, e.g.
Smith,Jane. Case- and space-insensitive. Use it for group assignees, which have no staff ID. - folder_ehr_id (string, optional): EHR folder (category) ID.
- folder_name (string, optional): Folder (category) name, case-insensitive. Inbox documents use the full folder path, e.g.
Fax Inbox/Referrals. - review_required (string, optional):
truefor documents marked for review in the EHR,falsefor the rest. - patient_mrn (string, optional): Patient MRN.
- document_type (string, optional):
fileorvisit_note. - page (integer, optional): Page number (default: 1).
- page_size (integer, optional): Results per page, max 100 (default: 100).
Example Request
curl -G "https://api.usecobalt.com/v1/documents" \
-H "client_id: your_client_id" \
-H "client_secret: your_client_secret" \
-H "access_token: your_access_token" \
--data-urlencode "start_date=2026-10-05" \
--data-urlencode "end_date=2026-10-07" \
--data-urlencode "inbox=true" \
--data-urlencode "assigned_to_ehr_id=52685" \
--data-urlencode "review_required=true"
Example Response
{
"success": true,
"documents": [
{
"id": "3f1c2b7e9d4a4c6f8b2e1a0d5c7e9f12",
"file_name": "50_1a289685-9bcd-4f28-a00c-139ba48d506d.pdf",
"description": "Fax Inbox document",
"mime_type": "application/pdf",
"document_type": "file",
"patient_mrn": null,
"patient_ehr_id": null,
"encounter_ehr_id": null,
"folder_ehr_id": "137",
"folder_name": "Fax Inbox",
"assigned_to_ehr_id": "52685",
"assigned_to_name": "Smith,Jane",
"review_required": true,
"is_high_priority": false,
"tags": ["Referral"],
"scanned_date": "2026-10-05",
"service_date": null,
"has_file": false,
"created_at": "2026-10-05T14:02:11.000Z",
"updated_at": "2026-10-05T14:02:11.000Z"
}
],
"pagination": {
"page": 1,
"page_size": 100,
"total_count": 1,
"total_pages": 1
}
}
Staying Up To Date
Subscribe to thedocument.created and document.updated
sync events to hear about new
inbox documents and changes (reassigned, refiled, marked for review) without polling.
Status Codes
- 200: Documents returned.
- 400: Missing or invalid dates, an invalid filter value, or an invalid
page/page_size.
Authorizations
Query Parameters
Start of the date range (YYYY-MM-DD, inclusive). Matches the EHR scan date for inbox documents, otherwise the day Cobalt stored the document.
"2026-03-15"
End of the date range (YYYY-MM-DD, inclusive).
"2026-03-20"
Filter by patient Medical Record Number.
"12345"
Filter by type: "file" (a stored file) or "visit_note" (an encounter visit note, rendered to PDF on fetch).
file, visit_note "true" returns only documents synced from the EHR document inbox; "false" excludes them.
true, false Filter by EHR folder (category) ID.
Filter by folder (category) name, case-insensitive. Inbox documents use the full folder path, e.g. "Fax Inbox/Referrals".
"Lab Results"
Filter by assignee: a staff ehr_id from GET /v1/staff.
"staff-123"
Filter by assignee name as shown in the EHR (e.g. "Smith,Jane"), case- and space-insensitive. Use for group assignees, which have no staff ID.
Filter by whether the document is marked for review.
true, false Page number (default 1).
"1"
Results per page (1-100, default 100).
"100"