Skip to main content
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": [
        {}
      ],
      "externalId": "<string>",
      "patient": {
        "id": "<string>",
        "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>",
        "pronouns": "<string>",
        "preferredName": "<string>",
        "dateOfBirth": "2023-12-25",
        "patientMedications": [
          "<string>"
        ],
        "leadSource": "<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>",
        "dosespotPatientId": "<string>"
      },
      "note": {
        "id": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "provider": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "color": "<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

​
tz
string
required
​
date
string<date> | null
​
patient_id
string | null
​
note_id
string | null
​
tag_ids
string[] | null
​
tagIds
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
​
nextDate
string<date> | null