Get Attachments

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

{
  "date": "2023-12-25",
  "data": [
    {
      "id": "<string>",
      "gcsPath": "<string>",
      "originalFilename": "<string>",
      "signedUrl": "<string>",
      "name": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "noteId": "<string>",
      "thumbnailSignedUrl": "<string>",
      "annotations": [
        {}
      ],
      "patient": {
        "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>"
      },
      "note": {
        "id": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "nextDate": "2023-12-25"
}

GET

attachments

Get Attachments

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

{
  "date": "2023-12-25",
  "data": [
    {
      "id": "<string>",
      "gcsPath": "<string>",
      "originalFilename": "<string>",
      "signedUrl": "<string>",
      "name": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "noteId": "<string>",
      "thumbnailSignedUrl": "<string>",
      "annotations": [
        {}
      ],
      "patient": {
        "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>"
      },
      "note": {
        "id": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "nextDate": "2023-12-25"
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Query Parameters

string

required

date

string<date> | null

patient_id

string | null

Response

Successful Response

Represents a single day page of attachments for infinite scrolling by date.

date: The local day these attachments belong to (based on provided tz)
data: All attachments created on that day
next_date: The previous day (if any) that contains at least one attachment under the same inclusion rules, to be used as the cursor for the next page.

date

string<date>

required

data

NoteAttachmentResponse · object[]

required

Show child attributes

data.id

string

required

data.gcsPath

string

required

data.originalFilename

string

required

data.signedUrl

string

required

data.name

string

required

data.createdDate

string<date-time>

required

data.noteId

string | null

data.thumbnailSignedUrl

string | null

data.annotations

Annotations · object[] | null

data.patient

PatientSummary · object

Show child attributes

data.patient.id

string

required

The unique identifier for the user.

data.patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.patient.createdDate

string<date-time>

required

The date and time when the user was created.

data.patient.firstName

string | null

The user's first name.

data.patient.lastName

string | null

The user's last name.

data.patient.phoneNumber

string | null

The user's phone number.

data.patient.email

string | null

The user's email address.

data.patient.locationId

string | null

The location of the user.

data.patient.externalId

string | null

The user's external identifier if available.

data.patient.address

string | null

The user's primary address.

data.patient.addressLineTwo

string | null

Additional address information.

data.patient.city

string | null

The city of the user's address.

data.patient.state

string | null

The state of the user's address.

data.patient.zipCode

string | null

The postal code of the user's address.

data.patient.country

string | null

The country of the user's address.

data.patient.addressValid

boolean | null

Whether the user's address is valid.

data.patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

data.patient.isArchived

boolean | null

Whether the user is archived.

data.patient.primaryLocationId

string | null

The primary location of the user.

data.patient.gender

string | null

The gender of the patient.

data.patient.dateOfBirth

string<date> | null

The date of birth of the patient.

data.patient.patientMedications

string[] | null

List of patient's self-reported medications.

data.patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

data.patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

data.patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

data.patient.tags.id

string

required

Unique identifier for the patient tag

data.patient.tags.name

string

required

Name of the patient tag

data.patient.tags.isActive

boolean

required

Whether the tag is active

data.patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

data.patient.tags.emoji

string | null

Emoji associated with the tag

data.patient.tags.color

string | null

Color code for the tag (hex format)

data.patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

data.patient.creditBalance

integer | null

Patient's credit balance in cents.

data.patient.preferredProviderId

string | null

The preferred provider ID for this patient.

data.note

NoteAttachmentNote · object

Show child attributes

data.note.id

string

required

data.note.createdDate

string<date-time>

required

nextDate

string<date> | null

Delete Note Template Get Lot Numbers

⌘I

Getting Started

API

Tenant

Webhook

Get Attachments

Headers

Query Parameters

Response