Get all goals
This endpoint will return all goals in the firm relevant to the user accessing them.
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Query parameters
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [accounts].
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[name]
string Filter by name.
-
filter[description]
string Filter by description.
-
filter[progress]
string Filter by progress. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.
-
filter[complete_goal_by]
string Filter by Complete Goal By. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.
-
filter[priority]
string Filter by priority. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.
-
filter[account_uuids]
string Filter by a comma separated list of account UUIDs.
-
filter[circle_uuids]
string Filter by a comma separated list of circle UUIDs.
-
sort
string Field to sort by. Valid fields are [created_at, updated_at, progress, complete_goal_by, priority]. Negative sign to denote DESC. Defaults to 'created_at'.
-
per_page
integer Number of results to return with pagination (Default 15. Max 500).
curl \
--request GET 'https://api.plannrcrm.com/api/v2/goals' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"{
"data": [
{
"name": "Reduced Mileage",
"uuid": "2f2b0cc3-44ea-4e98-b897-c738205aa6ab",
"priority": "4",
"progress": "68",
"timeframe": "Within the year.",
"created_at": "2025-04-02T13:27:59+01:00",
"updated_at": "2025-04-02T13:27:59+01:00",
"description": "Reduce the amount of gas spent yearly.",
"shared_owner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "7cf051cd-f384-4364-ae3c-005857012fc2",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-02T13:27:59+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:59+01:00",
"with_login": true,
"inactive_at": "2025-04-02",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-04-02T13:27:59+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-02T13:27:59+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-04-02T13:27:59+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-02T13:27:59+01:00"
},
"target_amount": {
"amount": {
"example": "4000",
"description": "Money amount at their lowest denominator (for example: pennies)"
},
"currency": {
"example": "GBP",
"description": "Currency of the money"
},
"formatted": {
"example": "£40.00",
"description": "Money amount formatted with currency"
}
},
"complete_goal_by": "2026-04-02T13:27:59+01:00",
"shared_owner_type": "individual"
}
]
}