Skip to main content
GET
Read the tracking board

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Query Parameters

sourceId
string
required

Tracking source from GET /v4/patient-tracking/sources.

Example:

"pts_00000000000040008000000000000001"

facilityExternalIds
string

Comma-separated native facility ids. ModMed requires exactly one; EZDerm providers are practice-wide and ignore it, but any id sent must belong to the source.

Example:

"101"

providerExternalIds
string

Comma-separated native provider ids, at most 100. Matches the primary provider on ModMed and any encounter role on EZDerm (see the source's capabilities.providerFilter). An id the source does not know is a 400.

Example:

"2001,2002"

date
string

Calendar day YYYY-MM-DD in the source's timezone. Defaults to today there. Future days are refused; EZDerm reads today only (capability_unsupported).

Example:

"2026-10-16"

include
string

Comma-separated row expansions: patient (read:patients), contact (read:patients and read:patient_pii), visitDetails (read:appointments), insurance (read:patients and read:insurance_policies). A requested expansion without every listed scope is a 403 include_not_permitted.

Example:

"patient,visitDetails"

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required