# Supernotes

## Docs

- [Introduction](https://developer.supernotes.app/introduction.md): Welcome to the Supernotes Developer Documentation
- [Custom Collections](https://developer.supernotes.app/guides/custom-collections.md)
- [Enums](https://developer.supernotes.app/guides/enums.md)
- [Supernotes to Drafts](https://developer.supernotes.app/community-creations/supernotes-to-drafts.md)
- [ChatGPT iOS Shortcut](https://developer.supernotes.app/community-creations/chatgpt-ios-shortcut.md)
- [Youtube to iOS Shortcut](https://developer.supernotes.app/community-creations/youtube-to-ios-shortcut.md)
- [Webhooks](https://developer.supernotes.app/community-creations/webhooks.md)
- [Readwise to Supernotes](https://developer.supernotes.app/community-creations/readwise-to-supernotes.md)
- [Scriptable iOS Pinned Widget](https://developer.supernotes.app/community-creations/scriptable.md)
- [Rust client](https://developer.supernotes.app/third-party/rust-client.md)
- [Supervocab](https://developer.supernotes.app/third-party/supervocab.md)
- [Getting Started](https://developer.supernotes.app/api-reference/introduction.md): Here's how to get started with the Supernotes API
- [Resource limits](https://developer.supernotes.app/api-reference/resource-limits.md): Overview of API resource limits for different Supernotes plans.
- [ Get Card](https://developer.supernotes.app/api-reference/cards/get-card.md): Get a specified card
- [ Get Selected Cards](https://developer.supernotes.app/api-reference/cards/get-selected-cards.md): The "base query" for retrieving cards (memberships) – supports selecting, filtering, and ordering by any implemented metric
- [ Get Specified Cards](https://developer.supernotes.app/api-reference/cards/get-specified-cards.md): Get the full card memberships of all the card IDs passed in the request body
- [ Get Deleted Cards](https://developer.supernotes.app/api-reference/cards/get-deleted-cards.md): Get a list of recently deleted card IDs for this user
- [ Simple Create Card](https://developer.supernotes.app/api-reference/cards/simple-create-card.md): Create a single card with the minimum amount of data required
- [ Simple Append](https://developer.supernotes.app/api-reference/cards/simple-append.md): Append content to an existing card
- [ Daily Append](https://developer.supernotes.app/api-reference/cards/daily-append.md): Append markup to your daily card (or create a new one if it doesn't exist)
- [ Create Cards](https://developer.supernotes.app/api-reference/cards/create-cards.md): Create cards with full control over properties
- [ Update Cards](https://developer.supernotes.app/api-reference/cards/update-cards.md): Update many cards in one call
- [ Enroll In Card](https://developer.supernotes.app/api-reference/cards/enroll-in-card.md): 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.
- [ Remove Cards For Me](https://developer.supernotes.app/api-reference/cards/remove-cards-for-me.md): Completely remove access to cards for the current user
- [ Delete Cards For Everyone](https://developer.supernotes.app/api-reference/cards/delete-cards-for-everyone.md): Completely (and irreversibly) delete cards from the Supernotes platform
- [ Get Collections](https://developer.supernotes.app/api-reference/collections/get-collections.md): Get all collections owned by the user
- [ Get Deleted Collections](https://developer.supernotes.app/api-reference/collections/get-deleted-collections.md): Get the IDs of collections deleted by the user
- [ Get Collection](https://developer.supernotes.app/api-reference/collections/get-collection.md): Get the specified collection
- [ Create Collection](https://developer.supernotes.app/api-reference/collections/create-collection.md): Create a custom collection
- [ Delete Collection](https://developer.supernotes.app/api-reference/collections/delete-collection.md): Delete the specified collection
- [ Update Collection](https://developer.supernotes.app/api-reference/collections/update-collection.md): Update the specified collection
- [ Get Comments](https://developer.supernotes.app/api-reference/comments/get-comments.md): Get all comments for the specified card
- [ Edit Comment](https://developer.supernotes.app/api-reference/comments/edit-comment.md): Update the specified comment on the specified card
- [ Create Comment](https://developer.supernotes.app/api-reference/comments/create-comment.md): Create a new comment on the specified card
- [ Delete Comment](https://developer.supernotes.app/api-reference/comments/delete-comment.md): Delete the specified comment from the specified card
- [ Get Friends](https://developer.supernotes.app/api-reference/friends/get-friends.md)
- [ Send Friend Request](https://developer.supernotes.app/api-reference/friends/send-friend-request.md)
- [ Get Incoming Requests](https://developer.supernotes.app/api-reference/friends/get-incoming-requests.md)
- [ Get Outgoing Requests](https://developer.supernotes.app/api-reference/friends/get-outgoing-requests.md)
- [ Accept Friendship](https://developer.supernotes.app/api-reference/friends/accept-friendship.md)
- [ Delete Friendship](https://developer.supernotes.app/api-reference/friends/delete-friendship.md)
- [ Get User Api Keys](https://developer.supernotes.app/api-reference/api-keys/get-user-api-keys.md): Get all API keys for the user
- [ Modify Api Key](https://developer.supernotes.app/api-reference/api-keys/modify-api-key.md): Modify an API key for the user
- [ Create Api Key](https://developer.supernotes.app/api-reference/api-keys/create-api-key.md): Create a new API key for the user
- [ Delete Api Key](https://developer.supernotes.app/api-reference/api-keys/delete-api-key.md): Delete an API key for the user
- [ Get User Sending Email](https://developer.supernotes.app/api-reference/api-keys/get-user-sending-email.md): Get the user's email-sending key
- [ Create User Sending Email](https://developer.supernotes.app/api-reference/api-keys/create-user-sending-email.md): Create a new email-sending key for a user
- [ Delete User Sending Email](https://developer.supernotes.app/api-reference/api-keys/delete-user-sending-email.md): Delete a user's email-sending key
- [ Get Members](https://developer.supernotes.app/api-reference/members/get-members.md): Get data about members of this card (permissions, statuses, etc)
- [ Attempt Join](https://developer.supernotes.app/api-reference/members/attempt-join.md): Attempt to join a card (based on having access to some arbitrary ancestor card)
- [ Invite Member](https://developer.supernotes.app/api-reference/members/invite-member.md): Invite a friend directly to an existing card
- [ Respond To Invite](https://developer.supernotes.app/api-reference/members/respond-to-invite.md): Respond to a card invitation
- [ Modify Member](https://developer.supernotes.app/api-reference/members/modify-member.md): Update another user's card membership
- [ Delete Member](https://developer.supernotes.app/api-reference/members/delete-member.md): Delete the member from the specified card
- [ Get Current User Profile](https://developer.supernotes.app/api-reference/profiles/get-current-user-profile.md): Get the authenticated user's public profile
- [ Get Known Owner Profiles](https://developer.supernotes.app/api-reference/profiles/get-known-owner-profiles.md): Get the public profiles for all card owners the current user knows
- [ Get Other User Profile](https://developer.supernotes.app/api-reference/profiles/get-other-user-profile.md): Get the specified user's public profile
- [ Get Specified User Profiles](https://developer.supernotes.app/api-reference/profiles/get-specified-user-profiles.md): Get the public profiles for a specified list of users
- [ Get Synth Credits](https://developer.supernotes.app/api-reference/review/get-synth-credits.md): Get the number of synthetic credits the user has
- [ Get Share Codes For Card](https://developer.supernotes.app/api-reference/share/get-share-codes-for-card.md)
- [ Create Share Code](https://developer.supernotes.app/api-reference/share/create-share-code.md): Create a new share code (if user has permission)
- [ Update Share Code](https://developer.supernotes.app/api-reference/share/update-share-code.md): Modify an existing share code (if user has permission)
- [ Delete Share Code](https://developer.supernotes.app/api-reference/share/delete-share-code.md): Delete an existing share code (if user has permission)
- [ Find Card By Share Code](https://developer.supernotes.app/api-reference/share/find-card-with-share-code.md): Retrieve card data (and share code metadata) by specifying a share code
- [Authed find card with share code](https://developer.supernotes.app/api-reference/share/authed-find-card-with-share-code.md)
- [Join card with share code](https://developer.supernotes.app/api-reference/share/join-card-with-share-code.md)
- [ Get Users Tags](https://developer.supernotes.app/api-reference/tags/get-users-tags.md): Get all tags known to the user
- [ Get All Templates](https://developer.supernotes.app/api-reference/templates/get-all-templates.md): Get all templates for this user
- [ Edit Template](https://developer.supernotes.app/api-reference/templates/edit-template.md): Update the specified template
- [ Create Template](https://developer.supernotes.app/api-reference/templates/create-template.md): Create a new template
- [ Delete Template](https://developer.supernotes.app/api-reference/templates/delete-template.md): Delete the specified template
- [ Set Preferences](https://developer.supernotes.app/api-reference/user/set-preferences.md): Sets multiple preferences for the user
- [ Set Preference Flag](https://developer.supernotes.app/api-reference/user/set-preference-flag.md): Sets a boolean preference flag for the user
- [ Set Feature Preview Flag](https://developer.supernotes.app/api-reference/user/set-feature-preview-flag.md): Sets a boolean feature preview flag for the user
- [ Get User Email Addresses](https://developer.supernotes.app/api-reference/user/get-user-email-addresses.md): Get all emails for a user
- [ Get Email](https://developer.supernotes.app/api-reference/user/get-email.md)
- [ Delete Email](https://developer.supernotes.app/api-reference/user/delete-email.md)
- [ Make Email Primary](https://developer.supernotes.app/api-reference/user/make-email-primary.md)
- [ Check Auth](https://developer.supernotes.app/api-reference/user/check-auth.md): Check if using a valid authentication token and return the associated User ID
- [ Check If Fresh Access Token](https://developer.supernotes.app/api-reference/user/check-if-fresh-access-token.md): Check if the access token is 'fresh' and return the associated User ID
- [ Get Current User](https://developer.supernotes.app/api-reference/user/get-current-user.md): Get the authenticated user's information, including subscription details
- [ Update Current User](https://developer.supernotes.app/api-reference/user/update-current-user.md): Update the authenticated user's personal information
- [ Update Current User Bio And Pic](https://developer.supernotes.app/api-reference/user/update-current-user-bio-and-pic.md): Update a public user's profile bio and image
- [ Get Pins](https://developer.supernotes.app/api-reference/user/get-pins.md): Get the authenticated user's pins
- [ Update Pins](https://developer.supernotes.app/api-reference/user/update-pins.md): Modify which cards the user has 'pinned'
- [ Get User Webhooks](https://developer.supernotes.app/api-reference/webhooks/get-user-webhooks.md)
- [ Create Webhook](https://developer.supernotes.app/api-reference/webhooks/create-webhook.md)
- [ Modify Webhook](https://developer.supernotes.app/api-reference/webhooks/modify-webhook.md)
- [ Delete Webhook](https://developer.supernotes.app/api-reference/webhooks/delete-webhook.md)

## OpenAPI Specs

- [openapi](https://developer.supernotes.app/openapi.json)