Skip to content
Gospl Wiki

Paginated, filterable goal history (reverse-chronological).

GET
/goals/archive
 
curl --request GET \
  --url 'https://api.gospl.example/v1/goals/archive?type=all&page=1' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
userId
string format: uuid
type
string
Allowed values: all professional personal
month
string
/^\d{4}-\d{2}$/
year
integer
page
integer
default: 1 >= 1

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
items
required
Array<object>
object
id
required
string format: uuid
title
required
string
description
string
type
required
string
Allowed values: professional personal
status
required
string
Allowed values: active complete
weekStart
required

Anchors the goal to a week (G2).

string format: date
dateSet
required
string format: date-time
dateCompleted
string format: date-time
page
required
integer
totalPages
required
integer
Example 
{
  "items": [
    {
      "type": "professional",
      "status": "active"
    }
  ]
}

401

Section titled “401 ”

Missing/invalid credentials.

Media type application/json
object
code
required
string
message
required
string
Example generated
{
  "code": "example",
  "message": "example"
}

403

Section titled “403 ”

Authenticated but not permitted (incl. cross-tenant, out-of-chain).

Media type application/json
object
code
required
string
message
required
string
Example generated
{
  "code": "example",
  "message": "example"
}