Skip to content

Modules / Residents

Resident records

Operations

Get residents

Request

Retrieves residents with personal details, medical history, room location, and care preferences.

Filters:

  • homeId - Filter by specific care home
  • residentId - Filter by specific resident
  • startDate, endDate - Date range filtering
  • dateField - Date field to filter on (e.g., createdOn, admissionDate)
  • page, limit - Pagination controls (default: page=1, limit=10, max=100)
Security
bearer
Query
startDatestring, (date)

Start date for filtering (inclusive)

Example:startDate=2026-01-01
endDatestring, (date)

End date for filtering (inclusive)

Example:endDate=2026-12-31
pagenumber, >= 1

Page number (1-based)

Default:1
Example:page=1
limitnumber, [ 1 .. 100 ]

Number of records per page

Default:10
Example:limit=10
homeIdstring

Filter by home ID

Example:homeId=home-123-abc
residentIdstring

Filter by resident ID

Example:residentId=resident-456-def
dateFieldstring

Date field to filter on

Enum:"created_on""date_of_birth""admission_date""status_changed_on""ingested_on"
Example:dateField=created_on
GET
/api/residents
curl -i -X GET \
  'https://data.logmycare.co.uk/openapi/api/residents?startDate=2026-01-01&endDate=2026-12-31&page=1&limit=10&homeId=home-123-abc&residentId=resident-456-def&dateField=created_on'

Responses

Successfully retrieved records

Bodyapplication/json
dataArray of objectsrequired

Array of residents

Example:
[
  {
    "id": "69613fc010eecc5386f987ae",
    "name": { … },
    "email": "margaret.thompson@example.com",
    "gender": "female",
    "dateOfBirth": "1945-06-15T00:00:00.000Z",
    "createdOn": "2026-01-15T09:30:00.000Z",
    "admissionDate": "2026-01-10T00:00:00.000Z",
    "preferredName": "Maggie",
    "status": "active",
    "statusChangedOn": "2026-01-20T10:00:00.000Z",
    "isInactive": false,
    "home": { … },
    "location": { … },
    "nhsNumber": "999 000 0001",
    "bloodType": "O+",
    "allergies": "Penicillin",
    "hasAllergies": true,
    "noKnownAllergies": false,
    "residentAllergies": [ … ],
    "medicalHistory": "Hypertension, Type 2 diabetes",
    "height": "165cm",
    "gpCode": "G1234567",
    "gpName": "Dr. Sarah Williams",
    "gpEmail": "sarah.williams@nhs.example.com",
    "gpTelephone": "+44 1632 960123",
    "gpAddress": { … },
    "gpSurgeryName": "Example Medical Practice",
    "phones": [ … ],
    "addresses": [ … ],
    "importantContacts": [ … ],
    "preferredContactMethod": "noPreference",
    "religion": "Christian",
    "ethnicity": "White British",
    "nationality": "British",
    "nationalities": [ … ],
    "languagesSpoken": [ … ],
    "maritalStatus": "widowed",
    "birthplace": "York",
    "sexualPreference": "heterosexual",
    "carePackage": { … },
    "fundingSource": "localAuthority",
    "fundingSourceNotes": "Funded by York City Council",
    "fundingSourceOther": "",
    "keyworkers": [ … ],
    "carerPreferences": { … },
    "preferredDrink": "Tea with milk",
    "preferredAdminRoute": "oral",
    "dols": { … },
    "dolsStartDate": "2026-02-01T00:00:00.000Z",
    "dolsEndDate": "2026-08-01T00:00:00.000Z",
    "dolsReviewDate": "2026-05-01T00:00:00.000Z",
    "dolsApplicationDate": "2026-01-15T00:00:00.000Z",
    "dnacpr": { … },
    "dnacprDetails": "DNACPR in place, reviewed by GP",
    "dnacprReviewDate": "2026-06-01T00:00:00.000Z",
    "dnacprFormPhysicalLocation": "Front of care file",
    "recentMustScore": "1",
    "recentWaterlowScore": "12",
    "recentDrinkConsumption": "1500ml",
    "hasChokingRisk": false,
    "prnMedsNote": "Paracetamol PRN for pain",
    "nationalInsurance": "QQ123456C",
    "summary": "Margaret is a friendly resident who enjoys gardening and reading.",
    "otherIdentifiers": [ … ],
    "customId": "example-resident-id-123",
    "ageYears": 80
  }
]
paginationobject(PaginationMetaDto)required

Pagination metadata

Response
{
  "data": [
    { … }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 150,
    "totalPages": 15,
    "hasNext": true,
    "hasPrev": false
  }
}