Api-Key

Supernotes

API Reference

Go to App

Community

 Make Email Primary

Perm Name

Perm Value

PermErrorMeta

APIKeyHeader

SuccessMessage

AuthError

BasicError

CardError

PermError

RecaptchaError

TurnstileError

ValidationError

NumericError

Welcome to the Supernotes Developer Documentation

Introduction

Custom Collections

Supernotes to Drafts

ChatGPT iOS Shortcut

Youtube to iOS Shortcut

Readwise to Supernotes

Scriptable iOS Pinned Widget

Here's how to get started with the Supernotes API

Getting Started

Overview of API resource limits for different Supernotes plans.

 Get Card

The "base query" for retrieving cards (memberships) – supports selecting, filtering, and
ordering by any implemented metric

NOTE: This is a "POST-GET" endpoint – the method is POST (for the payload) but it GETs data

 Get Selected Cards

Get the full card memberships of all the card IDs passed in the request body

NOTE: This is a "POST-GET" endpoint – the method is POST (for the payload) but it GETs data

 Get Specified Cards

Get a list of recently deleted card IDs for this user

 Get Deleted Cards

Create a single card with the minimum amount of data required

 Simple Create Card

 Simple Append

Append markup to your daily card (or create a new one if it doesn't exist)

 Daily Append

Create cards with full control over properties

 Create Cards

 Update Cards

Enroll in a card – the current user will be given access to all child cards(that have been
published) within the specified card. If the user has already enrolled, this endpoint will
return all child cards to provide idempotency.

 Enroll In Card

Completely remove access to cards for the current user

 Remove Cards For Me

Completely (and irreversibly) delete cards from the Supernotes platform

 Delete Cards For Everyone

 Get Collections

Get the IDs of collections deleted by the user

 Get Deleted Collections

 Get Collection

 Create Collection

 Delete Collection

 Update Collection

 Get Comments

Update the specified comment on the specified card

 Edit Comment

Create a new comment on the specified card

 Create Comment

Delete the specified comment from the specified card

 Delete Comment

 Get Friends

 Send Friend Request

 Get Incoming Requests

 Get Outgoing Requests

 Accept Friendship

 Delete Friendship

 Get User Api Keys

 Modify Api Key

 Create Api Key

 Delete Api Key

 Get User Sending Email

Create a new email-sending key for a user

 Create User Sending Email

 Delete User Sending Email

Get data about members of this card (permissions, statuses, etc)

 Get Members

Attempt to join a card (based on having access to some arbitrary ancestor card)

 Attempt Join

Invite a friend directly to an existing card

 Invite Member

 Respond To Invite

 Modify Member

Delete the member from the specified card

 Delete Member

Get the authenticated user's public profile

 Get Current User Profile

Get the public profiles for all card owners the current user knows

 Get Known Owner Profiles

 Get Other User Profile

Get the public profiles for a specified list of users

 Get Specified User Profiles

Get the number of synthetic credits the user has

 Get Synth Credits

 Get Share Codes For Card

Create a new share code (if user has permission)

 Create Share Code

Modify an existing share code (if user has permission)

 Update Share Code

Delete an existing share code (if user has permission)

 Delete Share Code

Retrieve card data (and share code metadata) by specifying a share code.

 Find Card With Share Code

Retrieve card data (and share code metadata) by specifying a share code.
Check for auth headers and if the user already has access to this card, return a 409 error.

NOTE: `/v1/sharing/code/{code}/authed` path is deprecated – use `/v1/sharing/join/{code}`

 Authed Find Card With Share Code

Join a card via share code (if allowed) and return the newly joined card

NOTE: `/v1/sharing/code/{code}/join` path is deprecated – use `/v1/sharing/join/{code}`

 Join Card With Share Code

 Get Users Tags

 Get All Templates

 Edit Template

 Create Template

 Delete Template

 Set Preferences

Sets a boolean preference flag for the user

 Set Preference Flag

Sets a boolean feature preview flag for the user

 Set Feature Preview Flag

 Get User Email Addresses

 Get Email

 Delete Email

Check if using a valid authentication token and return the associated User ID

 Check Auth

Check if the access token is 'fresh' and return the associated User ID

 Check If Fresh Access Token

Get the authenticated user's information, including subscription details

 Get Current User

Update the authenticated user's personal information

 Update Current User

Update a public user's profile bio and image

Cards

Collections

Comments

Friends

Api Keys

Members

Profiles

Review

Share

Tags

Templates

User

Webhooks

Make Email Primary

Authorizations

Path Parameters

Response