Skip to main content
GET
List appointment types

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Query Parameters

inUseOnly
boolean

When true, return only types seen on at least one synced appointment. Useful for building a filter picker that offers nothing which would match zero appointments.

Example:

false

activeOnly
boolean

When true, return only types the practice can still book. Retired types are returned by default because historical appointments still reference them. ModMed only — EZDerm reports no status, so EZDerm types have active: null and are EXCLUDED by this filter.

Example:

false

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required