Skip to content

Get users

Request

Retrieves users with their roles, permissions, and homeIds. Password fields are excluded for security.

Filters:

  • homeId - Filter by specific care home
  • startDate, endDate - Date range filtering
  • dateField - Date field to filter on (default: createdOn)
  • page, limit - Pagination controls
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
dateFieldstring

Date field to filter on

Default:"created_on"
Enum:"created_on""start_date""end_date""last_seen_on""first_login_on""ingested_on"
Example:dateField=created_on
GET
/api/users
curl -i -X GET \
  'https://data.logmycare.co.uk/openapi/api/users?startDate=2026-01-01&endDate=2026-12-31&page=1&limit=10&dateField=created_on'

Responses

Successfully retrieved records

Bodyapplication/json
dataArray of objectsrequired

Array of users

Example:
[
  {
    "id": "68406c31e55ca6b6d2262f56",
    "name": { … },
    "email": "jane.smith@example.co.uk",
    "role": "carehome-admin",
    "cernerRole": "standard",
    "active": true,
    "deleted": false,
    "dateOfBirth": "1985-03-22T00:00:00.000Z",
    "startDate": "2026-01-02T00:00:00.000Z",
    "endDate": null,
    "createdOn": "2026-01-15T09:00:00.000Z",
    "lastSeen": "2026-02-10T16:45:00.000Z",
    "firstLogin": "2026-01-15T09:18:06.809Z",
    "phoneNumber": "+44 7700 900789",
    "address": { … },
    "allergies": "None",
    "hasAllergies": "no",
    "home": "5a1174a35dcb0e004030a28d",
    "homes": [ … ],
    "permissions": [ … ],
    "permissionsTemplate": "care-home-admin",
    "medicationPermission": true,
    "gpConnectPermission": false,
    "zones": [ … ],
    "allZones": false,
    "workProfile": { … },
    "hasRequestedDemo": false,
    "picture": "https://lmc-care-uploads.s3.eu-west-2.amazonaws.com/photos/users/example-user-id/avatar.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLE%2F20260115%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20260115T090000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=examplesignature",
    "summary": "Experienced care home administrator.",
    "customId": "example-admin-id-123",
    "resident": null,
    "emergencyContactName": { … },
    "emergencyContactRelation": "Spouse",
    "emergencyContactNumber": "+44 7700 900999"
  }
]
paginationobject(PaginationMetaDto)required

Pagination metadata

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