Note API

Get all notes in a deck

GET https://memoet.com/api/decks/:deck:id/notes

This endpoint allows you to get all notes in a deck.

Path Parameters

Name
Type
Description

deck:id*

string

ID of the deck.

Query Parameters

Name
Type
Description

limit

string

Number of notes per page.

before

string

Before cursor of current page.

after

string

After cursor of current page.

Headers

Name
Type
Description

Authentication*

string

Authentication token.

{
    "data": [
        {
            "id": "6f397ed6-e5d0-43af-9265-d2b14b8a9a7c",
            "title": "Which city is the capital of the United States of America? Which city is the capital of the United States of America? "
        }
    ],
    "metadata": {
        "after": null,
        "before": null,
        "limit": 1,
        "total_count": 3
    }
}

Create new notes

POST https://memoet.com/api/decks/:deck:id/notes

This endpoint allows you to create new notes for a deck.

Path Parameters

Name
Type
Description

deck:id*

string

ID of the deck to add notes to.

Headers

Name
Type
Description

Authentication*

string

Authentication token.

Request Body

Name
Type
Description

note

object

See example below.

{}

Body content example:

{
  "note": {
    "title": "Greenland is a part of which kingdom?",
    "content": "[Source](https://opentdb.com)",
    "type": "multiple_choice",
    "options": [
      {
        "content": "Sweden",
        "correct": false
      },
      {
        "content": "Denmark",
        "correct": true
      },
      {
        "content": "United Kingdom",
        "correct": false
      },
      {
        "content": "Norway",
        "correct": false
      }
    ]
  }
}

Retrieve / Update / Delete a note in deck

GET https://memoet.com/api/decks/:deck:id/notes/:note:id

Retrieve, update, delete a note by sending GET, PUT, DELETE request to endpoint above.

Path Parameters

Name
Type
Description

note:id*

string

ID of the note.

deck:id*

string

ID of the deck.

Headers

Name
Type
Description

Authentication*

string

Authentication token.

PreviousDeck API

Last updated