v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Referrals

List Letters

Find letters by patient, practice, and date range

get/api/2.0/letters/

Query parameters

document_date__gtstring date-time
document_date__gtestring date-time
document_date__ltstring date-time
document_date__ltestring date-time
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

patientinteger[]
practiceinteger[]
recipient_idinteger[]
recipient_namestring[]

Response

countinteger
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}