Skip to main content
GET
List visit statuses

Example Request

Example Response

This endpoint returns a list of all visit statuses configured for the account associated with the provided access token. Each status type includes a code and a description. The code can be used in our PATCH /appointments endpoint to update the status of an appointment.

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Response

Visit statuses for the account

success
boolean
required
Example:

true

data
object[]
required
Example:
warnings
string[]

Non-fatal warnings, also carried in Cobalt-Warning. Cached reads remain successful when sync is disabled. Permission-disabled sync warnings include EHR_DATA_MODEL_ACCESS_DENIED and explain restoring EHR access and re-enabling sync; cached data may be empty or stale. Other warning conventions are unchanged.