Get Encounter Attachments

GET

/api/encounter-attachments/v1/:encounter_id

GET

/api/encounter-attachments/v1/:encounter_id

1 import { CandidApiClient, CandidApi } from "candidhealth";
2 
3 const client = new CandidApiClient({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" });
4 await client.encounterAttachments.v1.get(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));

Try it

200Retrieved

1 [
2   {
3     "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4     "attachment_type": "DOCUMENTATION",
5     "authed_url": "authed_url",
6     "content_type": "content_type",
7     "description": "description",
8     "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
9     "file_name": "file_name"
10   },
11   {
12     "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
13     "attachment_type": "DOCUMENTATION",
14     "authed_url": "authed_url",
15     "content_type": "content_type",
16     "description": "description",
17     "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
18     "file_name": "file_name"
19   }
20 ]

Path parameters

encounter_idUUIDRequired

Response

This endpoint returns a list of objects.

attachment_idUUID

attachment_typeenum

Allowed values:

authed_urlstring

content_typestring

descriptionstring

encounter_idUUID

file_namestring

Path parameters

Headers

Response