Skip to content

Modules / Home Documents

Home-scoped document records

Operations

Get home documents (home-scoped documents)

Request

Retrieves home-scoped documents including policies, procedures, licenses, training materials, and other home-level documentation.

Filters:

  • homeId - Filter by specific care home
  • categoryId - Filter by home document category
  • startDate, endDate - Date range filtering
  • dateField - Date field to filter on (default: createdAt)
  • 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
categoryIdstring

Filter by home document category ID

Example:categoryId=5f155c4ac49007031a671d4f
dateFieldstring

Date field to filter on (only createdAt supported)

Default:"createdAt"
Value:"createdAt"
Example:dateField=createdAt
GET
/api/home-documents
curl -i -X GET \
  'https://data.logmycare.co.uk/openapi/api/home-documents?startDate=2026-01-01&endDate=2026-12-31&page=1&limit=10&homeId=home-123-abc&residentId=resident-456-def&categoryId=5f155c4ac49007031a671d4f&dateField=createdAt'

Responses

Successfully retrieved records

Bodyapplication/json
dataArray of objectsrequired

Array of home documents with enriched data

Example:
[
  {
    "id": "6915ffc2e924f18fb5af8879",
    "name": "Fire Safety Policy - 2026",
    "createdAt": "2026-11-13T15:56:50.600Z",
    "home": { … },
    "category": { … },
    "pdf": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/docs/home/homeDocuments/example-home-id/document-file.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260113%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260113T155650Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature",
    "originalFile": "Fire_Safety_Policy_2026.pdf"
  }
]
paginationobject(PaginationMetaDto)required

Pagination metadata

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