List an organisation’s entitlement overrides

GET

/entitlements/admin/orgs/{orgId}/overrides

curl --request GET \
  --url https://api.sloose.com/entitlements/admin/orgs/org_9f3c/overrides \
  --header 'Authorization: Bearer <token>'

• Production

Backoffice route: a staff session, or ADMIN_TOKEN; never a customer’s session. Includes revoked overrides, oldest first.

Authorizations

• sessionAuth
• adminToken

Parameters

Path Parameters

orgId

required

The organisation id.

string

Example

org_9f3c

The organisation id.

Responses

200

Every override, revoked ones included.

Media typeapplication/json

object

overrides

required

Array<object>

object

id

required

string

key

required

string

value

required

Any of:

number

number

boolean

boolean

null

null

reason

required

string

grantedBy

required

string

expiresAt

required

string | null

key

additional properties

Example^generated

{
  "overrides": [
    {
      "id": "example",
      "key": "example",
      "value": 1,
      "reason": "example",
      "grantedBy": "example",
      "expiresAt": "example"
    }
  ]
}

401

A bearer that is neither the token nor a live session (code: AUTH_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

A customer’s session, an API token, or no bearer at all — not staff, and not the ADMIN_TOKEN (code: ADMIN_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

503

The restore switch is on (code: MAINTENANCE): every route but /health and /robots.txt is refused before anything is read, except the operator’s own POST /staff/people/{id}/delete with the ADMIN_TOKEN. Sloose is down for maintenance. Please try again in a few minutes.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed value: MAINTENANCE

Example

{
  "code": "MAINTENANCE"
}

Headers

Retry-After

integer

Seconds until asking again is worth it (300 while the switch is on).