Pinal Developers

API reference

Notes

Notes, notebooks and sharing.

Base URL https://api.pinal.tech/v1

List notes

GET /notes

Notes, most recently edited first.

Query parameters

  • notebook string

    Notebook ID.

  • q string

    Full-text search.

  • limit integer

    Items per page, 1–100.

  • cursor string

    Opaque cursor from a previous page's next_cursor.

Responses

curl "https://api.pinal.tech/v1/notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Response · 200
{
  "notes": [
    {
      "id": "note_31d9aa",
      "title": "string",
      "content": "string",
      "notebook": "string",
      "pinned": true,
      "created_at": "2026-11-19T15:20:04Z",
      "updated_at": "2026-11-19T15:20:04Z"
    }
  ],
  "next_cursor": "string"
}

Create a note

POST /notes

Creates a note in a notebook (the default one if omitted). Content is Markdown.

Request body application/json

  • id string read-only
  • title string
  • content string

    Markdown.

  • notebook string
  • pinned boolean
  • created_at string (date-time) read-only
  • updated_at string (date-time) read-only

Responses

curl -X POST "https://api.pinal.tech/v1/notes" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Ideas",
    "content": "- Sunrise hike\n- Picnic at Lost Dutchman"
  }'
Response · 201
{
  "id": "note_31d9aa",
  "title": "string",
  "content": "string",
  "notebook": "string",
  "pinned": true,
  "created_at": "2026-11-19T15:20:04Z",
  "updated_at": "2026-11-19T15:20:04Z"
}

Get a note

GET /notes/{id}

One note with its content.

Path parameters

  • id string required

    Note ID.

Responses

curl "https://api.pinal.tech/v1/notes/{id}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
Response · 200
{
  "id": "note_31d9aa",
  "title": "string",
  "content": "string",
  "notebook": "string",
  "pinned": true,
  "created_at": "2026-11-19T15:20:04Z",
  "updated_at": "2026-11-19T15:20:04Z"
}

Update a note

PATCH /notes/{id}

Change the title, content or notebook.

Path parameters

  • id string required

    Note ID.

Request body application/json

  • id string read-only
  • title string
  • content string

    Markdown.

  • notebook string
  • pinned boolean
  • created_at string (date-time) read-only
  • updated_at string (date-time) read-only

Responses

curl -X PATCH "https://api.pinal.tech/v1/notes/{id}" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "note_31d9aa",
    "title": "string",
    "content": "string",
    "notebook": "string",
    "pinned": true,
    "created_at": "2026-11-19T15:20:04Z",
    "updated_at": "2026-11-19T15:20:04Z"
  }'
Response · 200
{
  "id": "note_31d9aa",
  "title": "string",
  "content": "string",
  "notebook": "string",
  "pinned": true,
  "created_at": "2026-11-19T15:20:04Z",
  "updated_at": "2026-11-19T15:20:04Z"
}

Delete a note

DELETE /notes/{id}

Moves it to the trash for 30 days.

Path parameters

  • id string required

    Note ID.

Responses

curl -X DELETE "https://api.pinal.tech/v1/notes/{id}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Share a note

POST /notes/{id}/share

Creates a share link or invites people by email.

Path parameters

  • id string required

    Note ID.

Request body application/json

  • invite array of string (email)
  • link boolean
  • access string

    One of view edit

Responses

curl -X POST "https://api.pinal.tech/v1/notes/{id}/share" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "invite": [
      "alex@pinal.email"
    ],
    "link": true,
    "access": "view"
  }'
Response · 200
{
  "url": "string",
  "invited": [
    "string"
  ]
}