For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
        • GETGet Encounter Attachments
        • PUTCreate Encounter Attachment
        • PUTCreate Encounter Attachment V2
        • POSTCreate an Attachment from a Charge Capture external ID
        • GETGet Attachments by Charge Capture External ID
        • DELDelete Attachment by Charge Capture External ID
        • DELDelete Encounter Attachment
Contact Sales
LogoLogo
API ReferenceEncounter AttachmentsV1

Get Attachments by Charge Capture External ID

Beta
GET
/api/encounter-attachments/v1/by-charge-capture-external-id/:charge_capture_external_id
GET
/api/encounter-attachments/v1/by-charge-capture-external-id/:charge_capture_external_id
$curl https://api.joincandidhealth.com/api/encounter-attachments/v1/by-charge-capture-external-id/charge_capture_external_id \
>     -H "Authorization: Bearer <token>"
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    "file_name": "file_name"
9  },
10  {
11    "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12    "attachment_type": "DOCUMENTATION",
13    "authed_url": "authed_url",
14    "content_type": "content_type",
15    "description": "description",
16    "file_name": "file_name"
17  }
18]
Returns all attachments associated with the given charge capture external ID.
Was this page helpful?
Previous

Delete Attachment by Charge Capture External ID

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

charge_capture_external_idstringRequired

Response

This endpoint returns a list of objects.
attachment_idUUID
attachment_typeenum
Allowed values:
authed_urlstring
content_typestring
descriptionstring
file_namestring