Skip to main content
List patients
curl --request GET \
  --url https://{tenantId}.api.nestmed.com/api/v1/patients \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "patientId": "<string>",
      "agencyId": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "dateOfBirth": "2023-12-25",
      "gender": "male",
      "medicalRecordNumber": "<string>",
      "status": "active",
      "address": {
        "street": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "apartment": "<string>"
      },
      "phoneNumbers": {
        "primary": "<string>",
        "secondary": "<string>"
      },
      "emergencyContact": {
        "name": "<string>",
        "relationship": "<string>",
        "phone": "<string>"
      },
      "insuranceInfo": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123,
    "offset": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
limit
integer
default:20
Required range: x <= 100
dateFrom
string<date>

Filter for records created or updated on or after this date (ISO 8601 format: YYYY-MM-DD).

dateTo
string<date>

Filter for records created or updated on or before this date (ISO 8601 format: YYYY-MM-DD).

Full-text search on patient name or MRN.

status
enum<string>
Available options:
active,
inactive,
deceased
episodeStatus
enum<string>
Available options:
active,
completed,
discharged

Response

200 - application/json

A paginated list of patients.

data
object[]
pagination
object