The caller's tenant settings.

GET

/admin/tenant-settings

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

• Production (placeholder)
• Mock server (generated from this contract)

Authorizations

• bearerAuth

Responses

200

OK

Media type application/json

object

tenantId

required

string format: uuid

timezone

required

IANA timezone. Default Europe/London (GMT/BST).

string

default: Europe/London

weekStartDay

required

Defines week boundaries for goals + summaries. Default Monday.

string

default: monday

Allowed values: monday sunday

Example

{
  "timezone": "Europe/London",
  "weekStartDay": "monday"
}

401

Missing/invalid credentials.

Media type application/json

object

code

required

string

message

required

string

Example ^generated

{
  "code": "example",
  "message": "example"
}

403

Not an admin, or cross-tenant.

Media type application/json

object

code

required

string

message

required

string

Example ^generated

{
  "code": "example",
  "message": "example"
}