Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
client_uuid
string Required
Query parameters
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [shared_owner].
-
filter[uuid]
string Filter by a comma separated list of 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).
GET
/api/v1/client/{client_uuid}/goal
curl \
--request GET 'https://api.plannrcrm.com/api/v1/client/client_uuid/goal' \
--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}"
Response examples (200)
{
"data": [
{
"name": "Reduced Mileage",
"uuid": "449ebd21-5c11-455e-9802-ae2c0b718bd1",
"priority": "4",
"progress": "68",
"timeframe": "Within the year.",
"created_at": "2025-04-02T13:27:55+01:00",
"updated_at": "2025-04-02T13:27:55+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": "fa2ba831-ee14-468e-8f1d-b7eb1dc26edc",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-04-02T13:27:55+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:55+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:55+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-04-02T13:27:55+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:55+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-04-02T13:27:55+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:55+01:00",
"shared_owner_type": "individual"
}
]
}