Skip to content
Patrimoine
v9.1.0

List Endpoint

GET
/api/v1/goal-templates
curl --request GET \
  --url 'https://example.com/api/v1/goal-templates?limit=50&offset=0'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 50 >= 1 <= 250
offset
Offset
integer
0

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Endpoint Api V1 Goal Templates Get
Array<object>
GoalTemplateOut
object
id
required
Id
integer
name
required
Name
string
kind
required
Kind
string
Allowed values: per_paycheck per_month
amount
required
Amount
string
usage_count
Usage Count
integer
0
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Example 

[
  {
    "kind": "per_paycheck",
    "usage_count": 0
  }
]

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": {}
    }
  ]
}