AI allowance

Get the AI allowance GET

Calendar feeds

Delete a calendar feed DELETE List calendar feeds GET

Copilot

Apply copilot actions POST List copilot conversations GET List copilot messages GET Send a copilot message POST

Docs

Read a docs page GET Search the docs GET

Files

Complete a file upload POST Start a file upload POST Delete a file DELETE Get a file GET List a note's files GET

Generation

Apply a generation POST Discard a generation POST Generate a note from sources POST Generate a note from a topic POST Generate a study set POST Get a generation GET

Identity

Get the key's user GET

Jobs

Cancel a job POST Get a job GET

Note folders

Create a note folder POST Delete a note folder DELETE List note folders GET Update a note folder PATCH

Notes

Append Markdown to a note POST Create a note POST Move a note to the trash DELETE Get a note with content GET List notes GET Write note content as Markdown PUT Restore a note from the trash POST Update a note PATCH

Practice

Answer a practice card POST Get a practice session's next cards GET Start a practice session POST Undo a practice answer POST

Practice tests

Create a practice test POST Create a practice test from your questions POST Get a practice test GET Get a practice test attempt GET List practice tests GET Save practice test answers PUT Start a practice test attempt POST Submit a practice test attempt POST

Recordings

Get a recording with its transcript GET List a note's recordings GET Save a recording's summary PUT

Reviews

Grade a flashcard POST Get the flashcard review queue GET

Schedules

Create a schedule POST Add a lesson POST Create a timetable with its lessons POST Remove a lesson DELETE Get a schedule GET Get a week of lessons GET List schedules GET Set a schedule's periods PUT Update a schedule PATCH Update a lesson PATCH

Search everything GET

Sets

Add terms to a study set POST Create a study set POST Delete a study set DELETE Delete a term DELETE Delete several terms POST Get a study set with its terms GET List a set's terms GET List study sets GET Update a study set PATCH Update a term PATCH Update several terms PATCH

Settings

Get the dashboard layout GET Get notification settings GET Get language, time zone and privacy GET Get the profile GET Get review settings GET Get task preferences GET Replace the dashboard layout PUT Resume notification email POST Update one notification kind PATCH Update notification settings PATCH Update language, time zone or privacy PATCH Update the profile PATCH Update review settings PATCH Update task preferences PATCH

Study blocks

Plan a study block POST Delete a study block DELETE List study blocks GET Update a study block PATCH

Subjects

Create a subject POST Delete a subject DELETE Get a subject GET List subjects GET Update a subject PATCH

Tasks

Add a subtask POST Create a task POST Create several tasks POST Delete a task DELETE Get a task GET List task types GET List tasks GET Update a task PATCH

Today

Get today's study overview GET

Webhooks

Create a webhook POST Delete a webhook DELETE Re-enable a webhook POST Get a webhook GET Inspect a delivery GET List a webhook's deliveries GET List webhooks GET Pause or resume a webhook POST Resend a delivery POST Rotate a webhook's secret POST Send a test event POST Edit a webhook PATCH

REST API

Get task preferences

GET

/settings/tasks

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

Required scopes: settings:view

Authorization

headerAuthorizationBearer <token>

Response Body

application/json

response

response
…

data*

Example Request

curl -X GET 'https://workroad.app/api/v1/settings/tasks' \  -H 'Authorization: Bearer $WORKROAD_API_KEY'

Example ResponseSchema

{  "data": {    "types": [      "Homework",      "Test",      "Study",      "Project"    ],    "overdueColor": "#ef4444",    "dueTodayColor": "#f97316",    "nearlyDueColor": "#eab308"  }}

Get review settings GET

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

Replace the dashboard layout PUT

Sets which cards the dashboard shows, in order, and their sizes.

Get task preferences

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Response Body