Get Encounter Attachments

GET

/api/encounter-attachments/v1/:encounter_id

GET

/api/encounter-attachments/v1/:encounter_id

curl https://api.joincandidhealth.com/api/encounter-attachments/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
     -H "Authorization: Bearer <token>"

200Retrieved

[
  {
    "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "attachment_type": "DOCUMENTATION",
    "authed_url": "authed_url",
    "content_type": "content_type",
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": {
      "user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "idp_metadata": [
        {
          "type": "auth_zero_metadata",
          "auth0_id": "auth0_id"
        },
        {
          "type": "auth_zero_metadata",
          "auth0_id": "auth0_id"
        }
      ],
      "user_metadata": {
        "type": "machine_user_metadata",
        "name": "name"
      },
      "primary_organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
    },
    "description": "description",
    "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "file_name": "file_name"
  },
  {
    "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "attachment_type": "DOCUMENTATION",
    "authed_url": "authed_url",
    "content_type": "content_type",
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": {
      "user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
      "idp_metadata": [
        {
          "type": "auth_zero_metadata",
          "auth0_id": "auth0_id"
        },
        {
          "type": "auth_zero_metadata",
          "auth0_id": "auth0_id"
        }
      ],
      "user_metadata": {
        "type": "machine_user_metadata",
        "name": "name"
      },
      "primary_organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
    },
    "description": "description",
    "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "file_name": "file_name"
  }
]

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

encounter_idUUIDRequired

Response

This endpoint returns a list of objects.

attachment_idUUID

attachment_typeenum

authed_urlstring

content_typestring

created_atdatetime

created_byobject

descriptionstring

encounter_idUUID

file_namestring