Skip to content
Gospl Wiki

Three-column board (Previous / This / Next) for a user.

GET
/goals/board
 
curl --request GET \
  --url https://api.gospl.example/v1/goals/board \
  --header 'Authorization: Bearer <token>'

Defaults to the caller. userId lets a permitted manager view a direct report (US-006); 403 if the caller isn’t permitted by the reporting-line graph (G3). Columns derived from the current week (G2); within each, Professional before Personal.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
userId
string format: uuid

Defaults to the caller. Manager access gated by reporting line.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
owner
required
object
id
required
string format: uuid
name
required
string
team
string
viewerIsOwner
boolean
previous
required
object
week
required
string
Allowed values: previous this next
readOnly
boolean
professional
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
personal
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
this
required
object
week
required
string
Allowed values: previous this next
readOnly
boolean
professional
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
personal
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
next
required
object
week
required
string
Allowed values: previous this next
readOnly
boolean
professional
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
personal
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
Example 
{
  "previous": {
    "week": "previous",
    "professional": [
      {
        "type": "professional",
        "status": "active"
      }
    ],
    "personal": [
      {
        "type": "professional",
        "status": "active"
      }
    ]
  },
  "this": {
    "week": "previous",
    "professional": [
      {
        "type": "professional",
        "status": "active"
      }
    ],
    "personal": [
      {
        "type": "professional",
        "status": "active"
      }
    ]
  },
  "next": {
    "week": "previous",
    "professional": [
      {
        "type": "professional",
        "status": "active"
      }
    ],
    "personal": [
      {
        "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"
}