List all documents

Updated:

GET/healthcare/{connection_id}/document

Returns a list of HealthcareDocuments. Narrow the results with the query parameters before paging, then page through them with `limit` and `offset` (the default and maximum page size depend on the integration). Use `fields` to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the `X-Total-Count` response header. Use each item's `id` to retrieve, update, or delete it where those operations are supported.

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
patient_idstring
The patient ID to filter by
type enum
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Returns

idstring
Unique identifier for the document
created_atdate-time
When the document record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
When the document record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
patient_idstring
The patient the document is about
encounter_idstring
The encounter the document relates to
practitioner_idstring
The practitioner who authored the document
namestring
Title or description of the document
type enum
Valid values:
"PROGRESS_NOTE"
"CONSULTATION_NOTE"
"HISTORY_AND_PHYSICAL"
"DISCHARGE_SUMMARY"
"PROCEDURE_NOTE"
Unified, normalized kind of clinical document (OTHER when unmappable)
codes array
Codings for the kind of document (e.g. LOINC document type)
status enum
Valid values:
"CURRENT"
"SUPERSEDED"
"ENTERED_IN_ERROR"
"OTHER"
Status of the document
filenamestring
File name of the document
mime_typestring
MIME type of the document content (e.g. text/plain, application/pdf)
document_urlstring
Download link for the document content, expires after 1 hour
document_datastring
Base64-encoded document content for create
authored_atdate-time
When the document was written (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadata array
Custom field values

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/healthcare/5de520f96e439b002043d8dc/document',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-10-24T20:38:16.397Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    patient_id: '',
    type: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?