Skip to content

Get goals

Request

Retrieves care goals with objectives, progress tracking, action plans, success measurements, and review history.

Filters:

  • homeId - Filter by specific care home
  • residentId - Filter by specific resident
  • startDate, endDate - Date range filtering
  • 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
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

Default:"created_on"
Enum:"created_on""edited_on""start_date""end_date""ingested_on"
Example:dateField=created_on
GET
/api/goals
curl -i -X GET \
  'https://data.logmycare.co.uk/openapi/api/goals?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 goals

Example:
[
  {
    "id": "6968bf21c441cf6fb4ac9a3e",
    "home": { … },
    "resident": { … },
    "createdBy": { … },
    "editedBy": { … },
    "logs": [ … ],
    "title": "Improve Mobility",
    "seenBy": [],
    "status": "notStarted",
    "actions": [],
    "endDate": "2026-06-30T00:00:00.000Z",
    "editedOn": "2026-01-23T14:18:42.514Z",
    "createdOn": "2026-01-15T10:30:00.000Z",
    "startDate": "2026-01-15T00:00:00.000Z",
    "importance": 8,
    "description": "Increase independent walking distance to 50 meters",
    "nextReviewDate": "2026-03-30T00:00:00.000Z",
    "progressHistory": [ … ],
    "successMeasurement": "Able to walk 50 meters independently"
  }
]
paginationobject(PaginationMetaDto)required

Pagination metadata

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