We are currently working on this comprehensive set of docs for getting started with the Supernotes API, but they are not ready yet. In the meantime, a complete API Reference can be found using your preferred OpenAPI spec below:
API keys can be used to interact with the Supernotes API, and are managed directly from your Supernotes account. To find them, start by clicking the User button, then > Settings > Manage Account > Manage API Keys. From there you can create, view, or delete API keys.
Warning: API keys give full access to a Supernotes account. Anyone with an API
key can create, edit, or delete any cards on that account.
If you would like further assistance or share what you are building with our API please head over to the developers section of our Community.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Supernotes","colors":{"primary":"#E43051","light":"#FF6682","dark":"#FF6682"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/supernotes/hjRyA1iIPTNbUf61/logo/light.svg?fit=max\u0026auto=format\u0026n=hjRyA1iIPTNbUf61\u0026q=85\u0026s=7ac49a30b82a4e7a4827244dc26cddfe","dark":"https://mintcdn.com/supernotes/hjRyA1iIPTNbUf61/logo/dark.svg?fit=max\u0026auto=format\u0026n=hjRyA1iIPTNbUf61\u0026q=85\u0026s=29c35c9c3986c36505c3f9f38ccc8564"},"api":{"openapi":"https://api.supernotes.app/openapi.json","mdx":{"server":"https://api.supernotes.app/","auth":{"method":"key","name":"Api-Key"}}},"navbar":{"links":[{"label":"Community","href":"https://community.supernotes.app/c/developers/11"}],"primary":{"type":"button","label":"Go to App","href":"https://my.supernotes.app/"}},"footer":{"socials":{"twitter":"https://twitter.com/supernotesapp","linkedin":"https://www.linkedin.com/company/supernotes"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"supernotes","hasAudioNarration":false,"actualSubdomain":"supernotes","customDomains":["developer.supernotes.app"],"gitSource":{"type":"github","owner":"supernotes","repo":"developer-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21c92c1d603ef037f085f8","collectionId":"7b514e4f-857a-43b3-bff8-af99fe5f8ca3","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21c92c1d603ef037f085f8:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":78},{"language":"default","tag":"User","count":14},{"language":"default","tag":"Cards","count":12},{"language":"default","tag":"Documentation","count":11},{"language":"default","tag":"Api Keys","count":7},{"language":"default","tag":"Share","count":7},{"language":"default","tag":"Collections","count":6},{"language":"default","tag":"Friends","count":6},{"language":"default","tag":"Members","count":6},{"language":"default","tag":"Community Creations","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Getting Started","description":"Here's how to get started with the Supernotes API","href":"/api-reference/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Here’s how to get started with the Supernotes API\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Card,CardGroup,Heading,Info,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Info,{children:_jsxs(_components.p,{children:[`These docs are currently work in progress if you notice anything please open\nan issue or submit a pull request over on the `,_jsx(_components.a,{href:`https://github.com/supernotes/developer-docs`,children:`Github\nrepository`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`welcome`,children:`Welcome`}),`\n`,_jsx(_components.p,{children:`We are currently working on this comprehensive set of docs for getting started with the Supernotes API, but they are not ready yet. In the meantime, a complete API Reference can be found using your preferred OpenAPI spec below:`}),`\n`,_jsxs(CardGroup,{cols:3,children:[_jsx(Card,{title:`RapiDoc`,href:`https://api.supernotes.app/docs/rapidoc`}),_jsx(Card,{title:`ReDoc`,href:`https://api.supernotes.app/docs/redoc`}),_jsx(Card,{title:`Swagger`,href:`https://api.supernotes.app/docs/swagger`})]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`API keys can be used to interact with the Supernotes API, and are managed directly from your Supernotes account. To find them, start by clicking the User button, then > Settings > Manage Account > Manage API Keys. From there you can create, view, or delete API keys.`}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Warning: API keys give full access to a Supernotes account. Anyone with an API\nkey can create, edit, or delete any cards on that account.`})}),`\n`,_jsx(Heading,{level:`2`,id:`developers-corner`,children:`Developers Corner`}),`\n`,_jsxs(_components.p,{children:[`If you would like further assistance or share what you are building with our API please head over to the developers section of our `,_jsx(_components.a,{href:`https://community.supernotes.app/c/developers/11`,children:`Community`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Getting Started","description":"Here's how to get started with the Supernotes API","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Welcome","slug":"welcome","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Developers Corner","slug":"developers-corner","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"supernotes","siteName":"Supernotes","title":"Getting Started - Supernotes","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-10T20:50:24.205Z","originalFileLocation":"api-reference/introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Here\u0026#x27;s how to get started with the Supernotes API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Supernotes\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/supernotes/LN371KF1Rv7SZwqZ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/supernotes/LN371KF1Rv7SZwqZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/supernotes/LN371KF1Rv7SZwqZ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/supernotes/LN371KF1Rv7SZwqZ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/supernotes/LN371KF1Rv7SZwqZ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/supernotes/LN371KF1Rv7SZwqZ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/supernotes/LN371KF1Rv7SZwqZ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/supernotes/LN371KF1Rv7SZwqZ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/supernotes/LN371KF1Rv7SZwqZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Getting Started - Supernotes\">\u003cmeta data-mint-head property=\"og:description\" content=\"Here\u0026#x27;s how to get started with the Supernotes API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Supernotes\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.supernotes.app/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://supernotes.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Getting+Started\u0026amp;description=Here%27s+how+to+get+started+with+the+Supernotes+API\u0026amp;theme=a5a3e14601020d34aa37d819\u0026amp;signature=a25efae1c7d37f74169e74726acdd43ab3765711626dbe7e83e1ed1caecc3e49\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Getting Started - Supernotes\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Here\u0026#x27;s how to get started with the Supernotes API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://supernotes.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Getting+Started\u0026amp;description=Here%27s+how+to+get+started+with+the+Supernotes+API\u0026amp;theme=a5a3e14601020d34aa37d819\u0026amp;signature=a25efae1c7d37f74169e74726acdd43ab3765711626dbe7e83e1ed1caecc3e49\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/supernotes/LN371KF1Rv7SZwqZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Supernotes\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E43051\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.supernotes.app/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.supernotes.app/#organization\",\"name\":\"Supernotes\",\"url\":\"https://developer.supernotes.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/supernotes/hjRyA1iIPTNbUf61/logo/light.svg?fit=max\u0026auto=format\u0026n=hjRyA1iIPTNbUf61\u0026q=85\u0026s=7ac49a30b82a4e7a4827244dc26cddfe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.supernotes.app#website\",\"name\":\"Supernotes\",\"url\":\"https://developer.supernotes.app\",\"publisher\":{\"@id\":\"https://developer.supernotes.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.supernotes.app/api-reference/introduction#webpage\",\"url\":\"https://developer.supernotes.app/api-reference/introduction\",\"name\":\"Getting Started\",\"description\":\"Here's how to get started with the Supernotes API\",\"dateModified\":\"2025-08-10T20:50:24.205Z\",\"isPartOf\":{\"@id\":\"https://developer.supernotes.app#website\"},\"breadcrumb\":{\"@id\":\"https://developer.supernotes.app/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.supernotes.app/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Supernotes\",\"item\":\"https://developer.supernotes.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Getting Started\",\"item\":\"https://developer.supernotes.app/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developer.supernotes.app/api-reference/introduction#article\",\"headline\":\"Getting Started\",\"name\":\"Getting Started\",\"description\":\"Here's how to get started with the Supernotes API\",\"url\":\"https://developer.supernotes.app/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://developer.supernotes.app/api-reference/introduction#webpage\"},\"dateModified\":\"2025-08-10T20:50:24.205Z\",\"publisher\":{\"@id\":\"https://developer.supernotes.app/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.supernotes.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Supernotes\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Supernotes","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"","pages":[{"title":"Getting Started","href":"/api-reference/introduction"},{"description":"Overview of API resource limits for different Supernotes plans.","title":null,"href":"/api-reference/resource-limits"}]},{"group":"Cards","pages":[{"openapi":"get /v1/cards/{card_id}","title":" Get Card","href":"/api-reference/cards/get-card"},{"openapi":"post /v1/cards/get/select","title":" Get Selected Cards","href":"/api-reference/cards/get-selected-cards"},{"openapi":"post /v1/cards/get/specify","title":" Get Specified Cards","href":"/api-reference/cards/get-specified-cards"},{"openapi":"get /v1/cards/get/deleted","title":" Get Deleted Cards","href":"/api-reference/cards/get-deleted-cards"},{"openapi":"post /v1/cards/simple","title":" Simple Create Card","href":"/api-reference/cards/simple-create-card"},{"openapi":"put /v1/cards/simple/{card_id}/append","title":" Simple Append","href":"/api-reference/cards/simple-append"},{"openapi":"put /v1/cards/daily","title":" Daily Append","href":"/api-reference/cards/daily-append"},{"openapi":"post /v1/cards","title":" Create Cards","href":"/api-reference/cards/create-cards"},{"openapi":"patch /v1/cards","title":" Update Cards","href":"/api-reference/cards/update-cards"},{"openapi":"put /v1/cards/enroll/{card_id}","title":" Enroll In Card","href":"/api-reference/cards/enroll-in-card"},{"openapi":"post /v1/cards/remove","title":" Remove Cards For Me","href":"/api-reference/cards/remove-cards-for-me"},{"openapi":"post /v1/cards/delete","title":" Delete Cards For Everyone","href":"/api-reference/cards/delete-cards-for-everyone"}]},{"group":"Collections","pages":[{"openapi":"get /v1/collections","title":" Get Collections","href":"/api-reference/collections/get-collections"},{"openapi":"get /v1/collections/deleted","title":" Get Deleted Collections","href":"/api-reference/collections/get-deleted-collections"},{"openapi":"get /v1/collections/{collection_id}","title":" Get Collection","href":"/api-reference/collections/get-collection"},{"openapi":"post /v1/collections/{collection_id}","title":" Create Collection","href":"/api-reference/collections/create-collection"},{"openapi":"delete /v1/collections/{collection_id}","title":" Delete Collection","href":"/api-reference/collections/delete-collection"},{"openapi":"patch /v1/collections/{collection_id}","title":" Update Collection","href":"/api-reference/collections/update-collection"}]},{"group":"Comments","pages":[{"openapi":"get /v1/comments/{card_id}","title":" Get Comments","href":"/api-reference/comments/get-comments"},{"openapi":"put /v1/comments/{card_id}/{comment_id}","title":" Edit Comment","href":"/api-reference/comments/edit-comment"},{"openapi":"post /v1/comments/{card_id}/{comment_id}","title":" Create Comment","href":"/api-reference/comments/create-comment"},{"openapi":"delete /v1/comments/{card_id}/{comment_id}","title":" Delete Comment","href":"/api-reference/comments/delete-comment"}]},{"group":"Friends","pages":[{"openapi":"get /v1/friends","title":" Get Friends","href":"/api-reference/friends/get-friends"},{"openapi":"post /v1/friends","title":" Send Friend Request","href":"/api-reference/friends/send-friend-request"},{"openapi":"get /v1/friends/incoming","title":" Get Incoming Requests","href":"/api-reference/friends/get-incoming-requests"},{"openapi":"get /v1/friends/outgoing","title":" Get Outgoing Requests","href":"/api-reference/friends/get-outgoing-requests"},{"openapi":"put /v1/friends/{other_user_id}","title":" Accept Friendship","href":"/api-reference/friends/accept-friendship"},{"openapi":"delete /v1/friends/{other_user_id}","title":" Delete Friendship","href":"/api-reference/friends/delete-friendship"}]},{"group":"Api Keys","pages":[{"openapi":"get /v1/keys","title":" Get User Api Keys","href":"/api-reference/api-keys/get-user-api-keys"},{"openapi":"put /v1/keys","title":" Modify Api Key","href":"/api-reference/api-keys/modify-api-key"},{"openapi":"post /v1/keys","title":" Create Api Key","href":"/api-reference/api-keys/create-api-key"},{"openapi":"post /v1/keys/delete","title":" Delete Api Key","href":"/api-reference/api-keys/delete-api-key"},{"openapi":"get /v1/keys/email","title":" Get User Sending Email","href":"/api-reference/api-keys/get-user-sending-email"},{"openapi":"post /v1/keys/email","title":" Create User Sending Email","href":"/api-reference/api-keys/create-user-sending-email"},{"openapi":"delete /v1/keys/email","title":" Delete User Sending Email","href":"/api-reference/api-keys/delete-user-sending-email"}]},{"group":"Members","pages":[{"openapi":"get /v1/members/{card_id}","title":" Get Members","href":"/api-reference/members/get-members"},{"openapi":"post /v1/members/{card_id}/attempt-join","title":" Attempt Join","href":"/api-reference/members/attempt-join"},{"openapi":"post /v1/members/{card_id}/invite/{user_id}","title":" Invite Member","href":"/api-reference/members/invite-member"},{"openapi":"put /v1/members/{card_id}/invite/{invite_response}","title":" Respond To Invite","href":"/api-reference/members/respond-to-invite"},{"openapi":"put /v1/members/{card_id}/{target_user_id}","title":" Modify Member","href":"/api-reference/members/modify-member"},{"openapi":"delete /v1/members/{card_id}/{target_user_id}","title":" Delete Member","href":"/api-reference/members/delete-member"}]},{"group":"Profiles","pages":[{"openapi":"get /v1/profiles","title":" Get Current User Profile","href":"/api-reference/profiles/get-current-user-profile"},{"openapi":"get /v1/profiles/known","title":" Get Known Owner Profiles","href":"/api-reference/profiles/get-known-owner-profiles"},{"openapi":"get /v1/profiles/{user_id}","title":" Get Other User Profile","href":"/api-reference/profiles/get-other-user-profile"},{"openapi":"post /v1/profiles/specify","title":" Get Specified User Profiles","href":"/api-reference/profiles/get-specified-user-profiles"}]},{"group":"Review","pages":[{"openapi":"get /v1/synth/credits","title":" Get Synth Credits","href":"/api-reference/review/get-synth-credits"}]},{"group":"Share","pages":[{"openapi":"get /v1/sharing/{card_id}","title":" Get Share Codes For Card","href":"/api-reference/share/get-share-codes-for-card"},{"openapi":"post /v1/sharing/{card_id}","title":" Create Share Code","href":"/api-reference/share/create-share-code"},{"openapi":"put /v1/sharing/{card_id}/{share_code_id}","title":" Update Share Code","href":"/api-reference/share/update-share-code"},{"openapi":"delete /v1/sharing/{card_id}/{share_code_id}","title":" Delete Share Code","href":"/api-reference/share/delete-share-code"},{"openapi":"get /v1/sharing/code/{code}","title":" Find Card By Share Code","href":"/api-reference/share/find-card-with-share-code"},{"openapi":"get /v1/sharing/code/{code}/authed","title":null,"href":"/api-reference/share/authed-find-card-with-share-code"},{"openapi":"post /v1/sharing/code/{code}/join","title":null,"href":"/api-reference/share/join-card-with-share-code"}]},{"group":"Tags","pages":[{"openapi":"get /v1/tags","title":" Get Users Tags","href":"/api-reference/tags/get-users-tags"}]},{"group":"Templates","pages":[{"openapi":"get /v1/templates","title":" Get All Templates","href":"/api-reference/templates/get-all-templates"},{"openapi":"put /v1/templates/{template_id}","title":" Edit Template","href":"/api-reference/templates/edit-template"},{"openapi":"post /v1/templates/{template_id}","title":" Create Template","href":"/api-reference/templates/create-template"},{"openapi":"delete /v1/templates/{template_id}","title":" Delete Template","href":"/api-reference/templates/delete-template"}]},{"group":"User","pages":[{"openapi":"patch /v1/user/prefs","title":" Set Preferences","href":"/api-reference/user/set-preferences"},{"openapi":"put /v1/user/prefs/flag/{pref_flag}","title":" Set Preference Flag","href":"/api-reference/user/set-preference-flag"},{"openapi":"put /v1/user/prefs/feature-preview/{feature_flag}","title":" Set Feature Preview Flag","href":"/api-reference/user/set-feature-preview-flag"},{"openapi":"get /v1/user/emails","title":" Get User Email Addresses","href":"/api-reference/user/get-user-email-addresses"},{"openapi":"get /v1/user/emails/{email_id}","title":" Get Email","href":"/api-reference/user/get-email"},{"openapi":"delete /v1/user/emails/{email_id}","title":" Delete Email","href":"/api-reference/user/delete-email"},{"openapi":"put /v1/user/emails/{email_id}/primary","title":" Make Email Primary","href":"/api-reference/user/make-email-primary"},{"openapi":"get /v1/user/token","title":" Check Auth","href":"/api-reference/user/check-auth"},{"openapi":"get /v1/user/token/fresh","title":" Check If Fresh Access Token","href":"/api-reference/user/check-if-fresh-access-token"},{"openapi":"get /v1/user","title":" Get Current User","href":"/api-reference/user/get-current-user"},{"openapi":"put /v1/user","title":" Update Current User","href":"/api-reference/user/update-current-user"},{"openapi":"put /v1/user/bio-and-pic","title":" Update Current User Bio And Pic","href":"/api-reference/user/update-current-user-bio-and-pic"},{"openapi":"get /v1/user/pins","title":" Get Pins","href":"/api-reference/user/get-pins"},{"openapi":"put /v1/user/pins","title":" Update Pins","href":"/api-reference/user/update-pins"}]},{"group":"Webhooks","pages":[{"openapi":"get /v1/webhooks","title":" Get User Webhooks","href":"/api-reference/webhooks/get-user-webhooks"},{"openapi":"post /v1/webhooks","title":" Create Webhook","href":"/api-reference/webhooks/create-webhook"},{"openapi":"put /v1/webhooks/{webhook_id}","title":" Modify Webhook","href":"/api-reference/webhooks/modify-webhook"},{"openapi":"delete /v1/webhooks/{webhook_id}","title":" Delete Webhook","href":"/api-reference/webhooks/delete-webhook"}]}]}]},"basePath":"","title":"Getting Started - Supernotes","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}
Visitar URL original