Skip to content
WorkRoad home
REST API

Get review settings

GET
/settings/review

Daily new-card and review limits, FSRS desired retention, the daily goal, leech handling and per-subject overrides.

Required scopes: settings:view

Authorization

headerAuthorizationBearer <token>

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://workroad.app/api/v1/settings/review' \  -H 'Authorization: Bearer $WORKROAD_API_KEY'
Example Response
{  "data": {    "newPerDay": 20,    "reviewsPerDay": null,    "retention": 0.9,    "goalKind": "cards",    "goalTarget": 30,    "leechThreshold": 8,    "suspendLeeches": true,    "subjectOverrides": [      {        "subjectId": "5f0c1d2e-3a4b-4c5d-8e6f-7a8b9c0d1e2f",        "newPerDay": 10,        "reviewsPerDay": null,        "retention": 0.95      }    ],    "optimizedAt": null  }}

Get the profile GET

The user's name, username, bio and what their public profile shows.

Get task preferences GET

The task types the app offers and the colours of overdue and due tasks.