AI allowance

Copilot

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

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 tests

Create a practice test 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

Reviews

Grade a flashcard POST Get the flashcard review queue GET

Schedules

Create a schedule POST Add a lesson 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

Sets

Add terms to a study set POST Create a study set POST Delete a study set DELETE Delete a term DELETE 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

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 Delete a task DELETE Get a task GET List task types GET List tasks GET Update a task PATCH

Webhooks

Create a webhook POST Delete a webhook DELETE Re-enable a webhook POST List a webhook's deliveries GET List webhooks GET Rotate a webhook's secret POST Send a test event POST

REST API

List task types

GET

/task-types

The task types from the user's task settings, in their configured order. Use one as a task's type.

Required scopes: tasks:view

Authorization

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/task-types"

{  "data": [    "Generic",    "Homework",    "Test"  ]}

Get a task GET

List tasks GET

WorkRoad[BETA]

Legal

Social

YouTube X Instagram

List task types

Authorization

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

405application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`