Skip to content
Patrimoine
v9.1.0

Get Endpoint

GET
/api/v1/savings-goals/{goal_id}
curl --request GET \
  --url https://example.com/api/v1/savings-goals/1

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
goal_id
required
Goal Id
integer

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SavingsGoalOut
object
id
required
Id
integer
user_id
required
User Id
integer
name
required
Name
string
target_amount
required
Target Amount
string
current_amount
required
Current Amount
string
deadline
required
Any of:
string format: date
color
required
Any of:
string
archived
required
Archived
boolean
start_date
required
Any of:
string format: date
linked_account_ids
Linked Account Ids
Array<integer>
default:
funding_schedule_id
Any of:
integer
effective_schedule
Any of:
EffectiveScheduleOut

The pay schedule an envelope or goal actually uses: its pick, else the user’s default.

object
id
required
Id
integer
name
required
Name
string
is_default
required
Is Default
boolean
paydays_remaining
Any of:
integer
suggested_per_payday
Any of:
string
template_id
Any of:
integer
template_projection
Any of:
GoalProjectionOut

When a goal completes if its template’s contribution is made every paycheck or month.

object
template_name
required
Template Name
string
kind
required
Kind
string
Allowed values: per_paycheck per_month
amount
required
Amount
string
status
required
Status
string
Allowed values: reached projected no_schedule too_far
contributions_needed
Any of:
integer
projected_date
Any of:
string format: date
deadline_status
Any of:
string
Allowed values: on_track late
late_by
Any of:
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Example 

{
  "linked_account_ids": [],
  "template_projection": {
    "kind": "per_paycheck",
    "status": "reached",
    "deadline_status": "on_track"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}