Sign in
goals

List goals

List all goals a user can set.

get/users/{user_guid}/goals

Path parameters

user_guidstring required

The unique identifier for the user.

Query parameters

pagestring

Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified.

records_per_agestring

The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used.

Response

OK

Example response

{
  "goals": [
    {
      "account_guid": "ACT-4e431124-4a29-abf9-f059-ab232ac14dbf",
      "amount": 4500,
      "current_amount": 1651.27,
      "guid": "GOL-524ca5db-a2d5-44f3-b048-16de16059024",
      "goal_type_name": "PAYOFF",
      "meta_type_name": "VACATION",
      "name": "Save for Europe",
      "completed_at": "2015-06-19T10:37:04-06:00",
      "metadata": "Additional information",
      "position": 3,
      "projected_to_complete_at": "2022-06-14T16:03:53-00:00",
      "targeted_to_complete_at": "2026-12-08 00:00:00.000000",
      "track_type_name": "Track Type Name",
      "user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

Changes