Read complete appointment and bill histories for up to 25 charts

curl --request POST \
  --url https://api.maxcare.ai/v4/patients/history \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "patientIds": [
    "pat_c56103bcd39c46d39f3138dd2b5e05f6"
  ],
  "resources": [
    "appointments",
    "bills"
  ],
  "limit": 100,
  "cursors": [
    "<string>"
  ]
}
'

import requests

url = "https://api.maxcare.ai/v4/patients/history"

payload = {
    "patientIds": ["pat_c56103bcd39c46d39f3138dd2b5e05f6"],
    "resources": ["appointments", "bills"],
    "limit": 100,
    "cursors": ["<string>"]
}
headers = {
    "X-Organization-Id": "<x-organization-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Organization-Id': '<x-organization-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    patientIds: ['pat_c56103bcd39c46d39f3138dd2b5e05f6'],
    resources: ['appointments', 'bills'],
    limit: 100,
    cursors: ['<string>']
  })
};

fetch('https://api.maxcare.ai/v4/patients/history', 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.maxcare.ai/v4/patients/history",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'patientIds' => [
        'pat_c56103bcd39c46d39f3138dd2b5e05f6'
    ],
    'resources' => [
        'appointments',
        'bills'
    ],
    'limit' => 100,
    'cursors' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Organization-Id: <x-organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.maxcare.ai/v4/patients/history"

	payload := strings.NewReader("{\n  \"patientIds\": [\n    \"pat_c56103bcd39c46d39f3138dd2b5e05f6\"\n  ],\n  \"resources\": [\n    \"appointments\",\n    \"bills\"\n  ],\n  \"limit\": 100,\n  \"cursors\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Organization-Id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.maxcare.ai/v4/patients/history")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"patientIds\": [\n    \"pat_c56103bcd39c46d39f3138dd2b5e05f6\"\n  ],\n  \"resources\": [\n    \"appointments\",\n    \"bills\"\n  ],\n  \"limit\": 100,\n  \"cursors\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.maxcare.ai/v4/patients/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"patientIds\": [\n    \"pat_c56103bcd39c46d39f3138dd2b5e05f6\"\n  ],\n  \"resources\": [\n    \"appointments\",\n    \"bills\"\n  ],\n  \"limit\": 100,\n  \"cursors\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": "success",
  "data": {
    "snapshotAt": "<string>",
    "limitPerResource": 123,
    "patients": [
      {
        "patientId": "<string>",
        "found": true,
        "chart": {
          "id": "pat_c56103bcd39c46d39f3138dd2b5e05f6",
          "instanceId": "ins_0b6f2a1c9d8e4f7a8b6c5d4e3f2a1b0c",
          "ehrType": "modmed",
          "ehrPatientId": "112233",
          "mrn": "<string>",
          "updatedAt": "2026-10-01T14:03:11.412Z",
          "masterPatientId": "mpt_4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a",
          "duplicatePatientIds": [
            "<string>"
          ],
          "identityLinks": [
            {
              "patientId": "pat_c56103bcd39c46d39f3138dd2b5e05f6",
              "basis": "name_dob"
            }
          ],
          "identityReview": {
            "status": "linked",
            "candidates": [
              {
                "masterPatientId": "mpt_4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a",
                "matchedOn": [
                  "name_dob"
                ]
              }
            ]
          },
          "identityMembershipVersion": "<string>"
        },
        "appointments": {
          "status": "ok",
          "version": "<string>",
          "totalCount": 123,
          "hasMore": true,
          "nextCursor": "<string>",
          "readiness": {
            "status": "complete",
            "requestedFrom": "<string>",
            "requestedTo": "<string>",
            "asOf": "<string>",
            "liveAsOf": "<string>",
            "excludes": [
              "<string>"
            ],
            "scopes": [
              {
                "scope": "<string>",
                "status": "complete",
                "verifiedDays": 123,
                "totalDays": 123,
                "firstUnverifiedDay": "<string>",
                "lastUnverifiedDay": "<string>",
                "asOf": "<string>",
                "liveAsOf": "<string>",
                "lastFailureAt": "<string>",
                "lastFailureReason": "page-unread"
              }
            ],
            "pendingHydration": 123,
            "basis": "window",
            "patientRefresh": {
              "status": "complete",
              "verifiedAt": "<string>",
              "requestedAt": "<string>",
              "lastFailureAt": "<string>",
              "lastFailureReason": "possible-truncation"
            }
          },
          "items": [
            {
              "id": "apt_9f8e7d6c5b4a39281706f5e4d3c2b1a0",
              "ehrAppointmentId": "<string>",
              "status": "scheduled",
              "integrationStatus": "CHECKED_IN",
              "scheduledStartDate": "<string>",
              "scheduledEndDate": "<string>",
              "facilityId": "<string>",
              "ehrFacilityId": "<string>",
              "providerId": "<string>",
              "appointmentTypeName": "<string>",
              "isNewPatient": true,
              "isCosmetic": true,
              "createdAt": "<string>",
              "lastSyncedAt": "<string>",
              "removedFromEhrAt": "<string>"
            }
          ]
        },
        "bills": {
          "status": "ok",
          "version": "<string>",
          "totalCount": 123,
          "hasMore": true,
          "nextCursor": "<string>",
          "readiness": {
            "status": "complete",
            "requestedFrom": "<string>",
            "requestedTo": "<string>",
            "asOf": "<string>",
            "liveAsOf": "<string>",
            "excludes": [
              "<string>"
            ],
            "scopes": [
              {
                "scope": "<string>",
                "status": "complete",
                "verifiedDays": 123,
                "totalDays": 123,
                "firstUnverifiedDay": "<string>",
                "lastUnverifiedDay": "<string>",
                "asOf": "<string>",
                "liveAsOf": "<string>",
                "lastFailureAt": "<string>",
                "lastFailureReason": "page-unread"
              }
            ],
            "pendingHydration": 123,
            "basis": "window",
            "patientRefresh": {
              "status": "complete",
              "verifiedAt": "<string>",
              "requestedAt": "<string>",
              "lastFailureAt": "<string>",
              "lastFailureReason": "possible-truncation"
            }
          },
          "items": [
            {
              "id": "bil_0a1b2c3d4e5f46a7b8c9d0e1f2a3b4c5",
              "ehrBillId": "<string>",
              "dateOfService": "<string>",
              "status": "<string>",
              "isBillable": true,
              "isCosmetic": true,
              "facilityId": "<string>",
              "providerId": "<string>",
              "updatedAt": "<string>",
              "lastSyncedAt": "<string>",
              "codingGroups": [
                {
                  "id": "cgr_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6",
                  "dataSource": "ehr",
                  "status": "<string>",
                  "updatedAt": "<string>",
                  "diagnoses": [
                    {
                      "code": "L57.0",
                      "position": 123
                    }
                  ],
                  "lineItems": [
                    {
                      "code": "17000",
                      "units": "1.000",
                      "position": 123
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    ],
    "groups": [
      {
        "masterPatientId": "mpt_4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a",
        "memberIds": [
          "<string>"
        ],
        "missingMemberIds": [
          "<string>"
        ],
        "appointments": {
          "status": "complete"
        },
        "bills": {
          "status": "complete"
        }
      }
    ]
  }
}

{
  "code": "bad_request",
  "message": "'id' must be a valid UUID",
  "trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "code": "unauthorized",
  "message": "Invalid or missing API key",
  "trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "code": "forbidden",
  "message": "Insufficient scope",
  "trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "code": "rate_limit_exceeded",
  "message": "Rate limit exceeded. Maximum 1000 requests per 60 seconds.",
  "trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

Patients

Read complete appointment and bill histories for up to 25 charts

Every page in a response is read from one database snapshot. Each (chart, resource) pages on its own cursor, so a large chart cannot hold back the others. A cursor only continues the exact set it was cut from: if any row of that chart’s resource changed since, the resource comes back snapshot_changed and is restarted without a cursor. readiness says whether the platform has evidence the mirror holds the EHR’s rows — read it before treating an empty history as ‘no visits’. Unknown fields are rejected.

POST

patients

history

curl --request POST \
  --url https://api.maxcare.ai/v4/patients/history \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "patientIds": [
    "pat_c56103bcd39c46d39f3138dd2b5e05f6"
  ],
  "resources": [
    "appointments",
    "bills"
  ],
  "limit": 100,
  "cursors": [
    "<string>"
  ]
}
'

import requests

url = "https://api.maxcare.ai/v4/patients/history"

payload = {
    "patientIds": ["pat_c56103bcd39c46d39f3138dd2b5e05f6"],
    "resources": ["appointments", "bills"],
    "limit": 100,
    "cursors": ["<string>"]
}
headers = {
    "X-Organization-Id": "<x-organization-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Organization-Id': '<x-organization-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    patientIds: ['pat_c56103bcd39c46d39f3138dd2b5e05f6'],
    resources: ['appointments', 'bills'],
    limit: 100,
    cursors: ['<string>']
  })
};

fetch('https://api.maxcare.ai/v4/patients/history', 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.maxcare.ai/v4/patients/history",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'patientIds' => [
        'pat_c56103bcd39c46d39f3138dd2b5e05f6'
    ],
    'resources' => [
        'appointments',
        'bills'
    ],
    'limit' => 100,
    'cursors' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Organization-Id: <x-organization-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.maxcare.ai/v4/patients/history"

	payload := strings.NewReader("{\n  \"patientIds\": [\n    \"pat_c56103bcd39c46d39f3138dd2b5e05f6\"\n  ],\n  \"resources\": [\n    \"appointments\",\n    \"bills\"\n  ],\n  \"limit\": 100,\n  \"cursors\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Organization-Id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.maxcare.ai/v4/patients/history")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"patientIds\": [\n    \"pat_c56103bcd39c46d39f3138dd2b5e05f6\"\n  ],\n  \"resources\": [\n    \"appointments\",\n    \"bills\"\n  ],\n  \"limit\": 100,\n  \"cursors\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.maxcare.ai/v4/patients/history")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Organization-Id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"patientIds\": [\n    \"pat_c56103bcd39c46d39f3138dd2b5e05f6\"\n  ],\n  \"resources\": [\n    \"appointments\",\n    \"bills\"\n  ],\n  \"limit\": 100,\n  \"cursors\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": "success",
  "data": {
    "snapshotAt": "<string>",
    "limitPerResource": 123,
    "patients": [
      {
        "patientId": "<string>",
        "found": true,
        "chart": {
          "id": "pat_c56103bcd39c46d39f3138dd2b5e05f6",
          "instanceId": "ins_0b6f2a1c9d8e4f7a8b6c5d4e3f2a1b0c",
          "ehrType": "modmed",
          "ehrPatientId": "112233",
          "mrn": "<string>",
          "updatedAt": "2026-10-01T14:03:11.412Z",
          "masterPatientId": "mpt_4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a",
          "duplicatePatientIds": [
            "<string>"
          ],
          "identityLinks": [
            {
              "patientId": "pat_c56103bcd39c46d39f3138dd2b5e05f6",
              "basis": "name_dob"
            }
          ],
          "identityReview": {
            "status": "linked",
            "candidates": [
              {
                "masterPatientId": "mpt_4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a",
                "matchedOn": [
                  "name_dob"
                ]
              }
            ]
          },
          "identityMembershipVersion": "<string>"
        },
        "appointments": {
          "status": "ok",
          "version": "<string>",
          "totalCount": 123,
          "hasMore": true,
          "nextCursor": "<string>",
          "readiness": {
            "status": "complete",
            "requestedFrom": "<string>",
            "requestedTo": "<string>",
            "asOf": "<string>",
            "liveAsOf": "<string>",
            "excludes": [
              "<string>"
            ],
            "scopes": [
              {
                "scope": "<string>",
                "status": "complete",
                "verifiedDays": 123,
                "totalDays": 123,
                "firstUnverifiedDay": "<string>",
                "lastUnverifiedDay": "<string>",
                "asOf": "<string>",
                "liveAsOf": "<string>",
                "lastFailureAt": "<string>",
                "lastFailureReason": "page-unread"
              }
            ],
            "pendingHydration": 123,
            "basis": "window",
            "patientRefresh": {
              "status": "complete",
              "verifiedAt": "<string>",
              "requestedAt": "<string>",
              "lastFailureAt": "<string>",
              "lastFailureReason": "possible-truncation"
            }
          },
          "items": [
            {
              "id": "apt_9f8e7d6c5b4a39281706f5e4d3c2b1a0",
              "ehrAppointmentId": "<string>",
              "status": "scheduled",
              "integrationStatus": "CHECKED_IN",
              "scheduledStartDate": "<string>",
              "scheduledEndDate": "<string>",
              "facilityId": "<string>",
              "ehrFacilityId": "<string>",
              "providerId": "<string>",
              "appointmentTypeName": "<string>",
              "isNewPatient": true,
              "isCosmetic": true,
              "createdAt": "<string>",
              "lastSyncedAt": "<string>",
              "removedFromEhrAt": "<string>"
            }
          ]
        },
        "bills": {
          "status": "ok",
          "version": "<string>",
          "totalCount": 123,
          "hasMore": true,
          "nextCursor": "<string>",
          "readiness": {
            "status": "complete",
            "requestedFrom": "<string>",
            "requestedTo": "<string>",
            "asOf": "<string>",
            "liveAsOf": "<string>",
            "excludes": [
              "<string>"
            ],
            "scopes": [
              {
                "scope": "<string>",
                "status": "complete",
                "verifiedDays": 123,
                "totalDays": 123,
                "firstUnverifiedDay": "<string>",
                "lastUnverifiedDay": "<string>",
                "asOf": "<string>",
                "liveAsOf": "<string>",
                "lastFailureAt": "<string>",
                "lastFailureReason": "page-unread"
              }
            ],
            "pendingHydration": 123,
            "basis": "window",
            "patientRefresh": {
              "status": "complete",
              "verifiedAt": "<string>",
              "requestedAt": "<string>",
              "lastFailureAt": "<string>",
              "lastFailureReason": "possible-truncation"
            }
          },
          "items": [
            {
              "id": "bil_0a1b2c3d4e5f46a7b8c9d0e1f2a3b4c5",
              "ehrBillId": "<string>",
              "dateOfService": "<string>",
              "status": "<string>",
              "isBillable": true,
              "isCosmetic": true,
              "facilityId": "<string>",
              "providerId": "<string>",
              "updatedAt": "<string>",
              "lastSyncedAt": "<string>",
              "codingGroups": [
                {
                  "id": "cgr_1a2b3c4d5e6f47a8b9c0d1e2f3a4b5c6",
                  "dataSource": "ehr",
                  "status": "<string>",
                  "updatedAt": "<string>",
                  "diagnoses": [
                    {
                      "code": "L57.0",
                      "position": 123
                    }
                  ],
                  "lineItems": [
                    {
                      "code": "17000",
                      "units": "1.000",
                      "position": 123
                    }
                  ]
                }
              ]
            }
          ]
        }
      }
    ],
    "groups": [
      {
        "masterPatientId": "mpt_4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a",
        "memberIds": [
          "<string>"
        ],
        "missingMemberIds": [
          "<string>"
        ],
        "appointments": {
          "status": "complete"
        },
        "bills": {
          "status": "complete"
        }
      }
    ]
  }
}

{
  "code": "bad_request",
  "message": "'id' must be a valid UUID",
  "trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "code": "unauthorized",
  "message": "Invalid or missing API key",
  "trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "code": "forbidden",
  "message": "Insufficient scope",
  "trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "code": "rate_limit_exceeded",
  "message": "Rate limit exceeded. Maximum 1000 requests per 60 seconds.",
  "trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

Authorizations

Authorization

string

header

required

Marketplace API key

Headers

X-Organization-Id

string

required

Target clinic organization ID

Body

application/json

patientIds

string[]

required

Charts to read, 1–25. Each is answered independently: a chart outside your organization comes back found: false, never as an error that fails the batch.

Example:

["pat_c56103bcd39c46d39f3138dd2b5e05f6"]

resources

enum<string>[]

Resources to read. Defaults to both. appointments needs read:appointments, bills needs read:bills.

Available options:

appointments,

bills

Example:

["appointments", "bills"]

limit

number

Rows per patient per resource, 1–200 (default 100). Lowered to fit 2500 rows per response; the applied value is echoed as limitPerResource.

Example:

100

coverage

object

Window appointment readiness is judged over. Defaults to the last two years through today (UTC). Up to ten years.

Show child attributes

cursors

string[]

nextCursor values from a previous response. Each names its own patient and resource; a (patient, resource) without a cursor starts from its first row. Every cursor must name a patient in patientIds and a requested resource.

Response

Success

code

string

required

Response code

Example:

"success"

data

object

required

Show child attributes