Goals

Get Goal

Get a specific goal by ID.

get/api/goals/{goal_id}

Request

  • Base URL: https://api.earmarkiq.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.earmarkiq.app/api/goals/{goal_id}
  • Auth: HTTP bearer

Path parameters

goal_idstring uuid required

Response

Successful Response

idstring required
namestring required
iconstring nullable required
target_amountnumber required
saved_amountnumber required
effective_saved_amountnumber required
monthly_contributionnumber required
deadlinestring nullable required
priorityinteger required
categorystring required
progress_pctnumber required
created_atstring required
updated_atstring required
linked_account_idstring nullable
linked_account_namestring nullable
linked_account_balancenumber nullable
linked_investment_account_idstring nullable
linked_investment_account_namestring nullable
linked_investment_account_valuenumber nullable
shared_with_partnerboolean
joint_goalboolean
partner_link_idstring nullable
split_typestring nullable
your_percentageinteger nullable
partner_percentageinteger nullable
owner_namestring nullable
is_partner_goalboolean
pot_categorystring nullable
projectionobject nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.