Get Patient Table

curl --request GET \
  --url https://api.decodahealth.com/user/patient/table \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "id": "<string>",
      "type": "PROVIDER",
      "createdDate": "2023-11-07T05:31:56Z",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>",
      "locationId": "<string>",
      "externalId": "<string>",
      "address": "<string>",
      "addressLineTwo": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "addressValid": true,
      "meta": {},
      "isArchived": true,
      "primaryLocationId": "<string>",
      "gender": "<string>",
      "dateOfBirth": "2023-12-25",
      "patientMedications": [
        "<string>"
      ],
      "onSchedulingBlacklist": true,
      "surchargeDisabled": true,
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "isActive": true,
          "createdDate": "2023-11-07T05:31:56Z",
          "emoji": "<string>",
          "color": "<string>",
          "updatedDate": "2023-11-07T05:31:56Z"
        }
      ],
      "creditBalance": 123,
      "preferredProviderId": "<string>",
      "memberships": [
        {
          "id": "<string>",
          "membership": {
            "id": "<string>",
            "name": "<string>",
            "textColor": "<string>"
          },
          "startDate": "2023-11-07T05:31:56Z",
          "status": "ACTIVE"
        }
      ],
      "goalWeight": 123,
      "measurements": [
        {
          "patientId": "<string>",
          "createdDate": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "height": 123,
          "weight": 123,
          "systolicBp": 123,
          "diastolicBp": 123,
          "pulse": 123,
          "temperature": 123,
          "waistCircumference": 123,
          "noteId": "<string>",
          "measurementDate": "2023-11-07T05:31:56Z",
          "eventId": "<string>",
          "creatorId": "<string>"
        }
      ],
      "medications": [
        {
          "id": "<string>",
          "createdDate": "2023-11-07T05:31:56Z",
          "patientId": "<string>",
          "name": "<string>",
          "providerId": "<string>",
          "sideEffects": "<string>",
          "administrationLocation": "<string>",
          "amount": 123,
          "unit": "AMPOULES",
          "lotNumber": "<string>",
          "stockId": "<string>",
          "noteId": "<string>",
          "doseDate": "2023-11-07T05:31:56Z",
          "comment": "<string>",
          "frequency": "<string>",
          "quantity": 123,
          "isUsedAsTemplate": true,
          "signedOffProviderId": "<string>",
          "signedOffDate": "2023-11-07T05:31:56Z",
          "provider": {
            "id": "<string>",
            "type": "PROVIDER",
            "firstName": "<string>",
            "lastName": "<string>",
            "phoneNumber": "<string>",
            "email": "<string>",
            "locationId": "<string>"
          }
        }
      ],
      "optedOutOfSms": true,
      "appointmentCount": 0,
      "totalSpent": 0,
      "primaryLocationName": "<string>",
      "lastAppointmentDate": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

GET

user

patient

table

Get Patient Table

curl --request GET \
  --url https://api.decodahealth.com/user/patient/table \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "id": "<string>",
      "type": "PROVIDER",
      "createdDate": "2023-11-07T05:31:56Z",
      "firstName": "<string>",
      "lastName": "<string>",
      "phoneNumber": "<string>",
      "email": "<string>",
      "locationId": "<string>",
      "externalId": "<string>",
      "address": "<string>",
      "addressLineTwo": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "addressValid": true,
      "meta": {},
      "isArchived": true,
      "primaryLocationId": "<string>",
      "gender": "<string>",
      "dateOfBirth": "2023-12-25",
      "patientMedications": [
        "<string>"
      ],
      "onSchedulingBlacklist": true,
      "surchargeDisabled": true,
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "isActive": true,
          "createdDate": "2023-11-07T05:31:56Z",
          "emoji": "<string>",
          "color": "<string>",
          "updatedDate": "2023-11-07T05:31:56Z"
        }
      ],
      "creditBalance": 123,
      "preferredProviderId": "<string>",
      "memberships": [
        {
          "id": "<string>",
          "membership": {
            "id": "<string>",
            "name": "<string>",
            "textColor": "<string>"
          },
          "startDate": "2023-11-07T05:31:56Z",
          "status": "ACTIVE"
        }
      ],
      "goalWeight": 123,
      "measurements": [
        {
          "patientId": "<string>",
          "createdDate": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "height": 123,
          "weight": 123,
          "systolicBp": 123,
          "diastolicBp": 123,
          "pulse": 123,
          "temperature": 123,
          "waistCircumference": 123,
          "noteId": "<string>",
          "measurementDate": "2023-11-07T05:31:56Z",
          "eventId": "<string>",
          "creatorId": "<string>"
        }
      ],
      "medications": [
        {
          "id": "<string>",
          "createdDate": "2023-11-07T05:31:56Z",
          "patientId": "<string>",
          "name": "<string>",
          "providerId": "<string>",
          "sideEffects": "<string>",
          "administrationLocation": "<string>",
          "amount": 123,
          "unit": "AMPOULES",
          "lotNumber": "<string>",
          "stockId": "<string>",
          "noteId": "<string>",
          "doseDate": "2023-11-07T05:31:56Z",
          "comment": "<string>",
          "frequency": "<string>",
          "quantity": 123,
          "isUsedAsTemplate": true,
          "signedOffProviderId": "<string>",
          "signedOffDate": "2023-11-07T05:31:56Z",
          "provider": {
            "id": "<string>",
            "type": "PROVIDER",
            "firstName": "<string>",
            "lastName": "<string>",
            "phoneNumber": "<string>",
            "email": "<string>",
            "locationId": "<string>"
          }
        }
      ],
      "optedOutOfSms": true,
      "appointmentCount": 0,
      "totalSpent": 0,
      "primaryLocationName": "<string>",
      "lastAppointmentDate": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Query Parameters

page

integer | null

per_page

integer | null

sort_by

string | null

sort_direction

enum<string> | null

Available options:

asc,

desc

location_id

string | null

external_id

string | null

name

string | null

phone_number

string | null

date_of_birth

(string<date-time> | string)[] | null

created_date

string<date-time>[] | null

tag_ids

string[] | null

Filter by patient tag IDs

location_ids

string[] | null

Filter by primary location IDs

string | null

Response

Successful Response

data

PatientTable · object[]

required

Show child attributes

data.id

string

required

The unique identifier for the user.

data.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.createdDate

string<date-time>

required

The date and time when the user was created.

data.firstName

string | null

The user's first name.

data.lastName

string | null

The user's last name.

data.phoneNumber

string | null

The user's phone number.

data.email

string | null

The user's email address.

data.locationId

string | null

The location of the user.

data.externalId

string | null

The user's external identifier if available.

data.address

string | null

The user's primary address.

data.addressLineTwo

string | null

Additional address information.

data.city

string | null

The city of the user's address.

data.state

string | null

The state of the user's address.

data.zipCode

string | null

The postal code of the user's address.

data.country

string | null

The country of the user's address.

data.addressValid

boolean | null

Whether the user's address is valid.

data.meta

Meta · object

Any additional metadata about the user relevant to your system.

data.isArchived

boolean | null

Whether the user is archived.

data.primaryLocationId

string | null

The primary location of the user.

data.gender

string | null

The gender of the patient.

data.dateOfBirth

string<date> | null

The date of birth of the patient.

data.patientMedications

string[] | null

List of patient's self-reported medications.

data.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

data.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

data.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

data.tags.id

string

required

Unique identifier for the patient tag

data.tags.name

string

required

Name of the patient tag

data.tags.isActive

boolean

required

Whether the tag is active

data.tags.createdDate

string<date-time>

required

Date and time when the tag was created

data.tags.emoji

string | null

Emoji associated with the tag

data.tags.color

string | null

Color code for the tag (hex format)

data.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

data.creditBalance

integer | null

Patient's credit balance in cents.

data.preferredProviderId

string | null

The preferred provider ID for this patient.

data.memberships

MemberTiny · object[] | null

List of memberships for this patient

Show child attributes

data.memberships.id

string

required

Unique identifier for the member

data.memberships.membership

MembershipTiny · object

required

Membership details

Show child attributes

data.memberships.membership.id

string

required

Unique identifier for the membership

data.memberships.membership.name

string

required

Name of the membership

data.memberships.membership.textColor

string | null

Text color of the membership

data.memberships.startDate

string<date-time>

required

When the patient joined the membership

data.memberships.status

enum<string>

required

Current status of the membership

Available options:

ACTIVE,

EXPIRED,

CANCELLED,

DELINQUENT,

FROZEN

data.goalWeight

number | null

The goal weight of the patient.

data.measurements

MeasurementSummary · object[] | null

List of patient's measurements.

Show child attributes

data.measurements.patientId

string

required

data.measurements.createdDate

string<date-time>

required

data.measurements.id

string

required

data.measurements.height

number | null

The height of the patient in cms.

data.measurements.weight

number | null

The weight of the patient in kgs.

data.measurements.systolicBp

number | null

data.measurements.diastolicBp

number | null

data.measurements.pulse

number | null

data.measurements.temperature

number | null

data.measurements.waistCircumference

number | null

The waist circumference of the patient in cms.

data.measurements.noteId

string | null

data.measurements.measurementDate

string<date-time>

The date and time the measurement was taken. Defaults to now if not provided.

data.measurements.eventId

string | null

The event that the measurement was taken for.

data.measurements.creatorId

string | null

ID of the user who created this measurement (optional for legacy measurements)

data.medications

DeprecatedMedicationSummary · object[] | null

List of provider-administered medication doses.

Show child attributes

data.medications.id

string

required

data.medications.createdDate

string<date-time>

required

data.medications.patientId

string

required

data.medications.name

string

required

data.medications.providerId

string | null

data.medications.sideEffects

string | null

data.medications.administrationLocation

string | null

data.medications.amount

number | null

data.medications.unit

enum<string> | null

Available options:

AMPOULES,

APPLICATORS,

BOTTLES,

BOXES,

CAPSULES,

CUPS,

DOSES,

G_PER_ML,

GRAMS,

IU,

IU_PER_ML,

OUNCES,

FLUID_OUNCES,

KG,

KITS,

LITERS,

MCG,

MG,

MG_PER_ML,

ML,

MMOL,

MICROGRAM_PER_ML,

PACKS,

PAIRS,

PATCHES,

PERCENTAGE,

PIECES,

POUCHES,

ROLLS,

SACHETS,

SHEETS,

SPRAYS,

STRIPS,

SYRINGES,

TABLETS,

TABLETS_PER_DAY,

TESTS,

TUBES,

UNITS,

VIALS,

TREATMENTS,

SESSIONS,

PULSES,

JOULES,

CENTIMETERS,

THREAD_COUNT,

INJECTIONS,

WRINKLE_UNITS,

POUNDS,

FEET,

INCHES

data.medications.lotNumber

string | null

data.medications.stockId

string | null

data.medications.noteId

string | null

data.medications.doseDate

string<date-time> | null

data.medications.comment

string | null

data.medications.frequency

string | null

data.medications.quantity

number | null

data.medications.isUsedAsTemplate

boolean | null

data.medications.signedOffProviderId

string | null

data.medications.signedOffDate

string<date-time> | null

data.medications.provider

UserTiny · object

Show child attributes

data.medications.provider.id

string

required

The unique identifier for the user.

data.medications.provider.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.medications.provider.firstName

string | null

The user's first name.

data.medications.provider.lastName

string | null

The user's last name.

data.medications.provider.phoneNumber

string | null

The user's phone number.

data.medications.provider.email

string | null

The user's email address.

data.medications.provider.locationId

string | null

The location of the user.

data.optedOutOfSms

boolean | null

Whether patient has opted out of SMS

data.appointmentCount

integer

default:0

Total number of appointments for this patient (sortable)

data.totalSpent

integer

default:0

Total amount spent by this patient in cents (sortable)

data.primaryLocationName

string | null

Name of the patient's primary location

data.lastAppointmentDate

string<date-time> | null

Date of the patient's last completed appointment

total

integer

required

Get Patient Sidebar Snapshot Get Patient Tag

⌘I

Getting Started

API

Tenant

Webhook

Get Patient Table

Headers

Query Parameters

Response