NextAPI is a Next.js RESTful API Starter for building your next SaaS app
NextAPI handle the heavy lifting for common SaaS features such as authentication, team management, invites, subscriptions, and more.Say goodbye to tedious backend boilerplate code and focus on what matters most - building user-friendly UI/UX that delight your customers.With its powerful combination of Next.js, Supabase, and Prisma - NextAPI provides the perfect foundation for creating scalable and feature-rich SaaS apps.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"NextAPI","colors":{"primary":"#12A7D3","light":"#81D7F7","dark":"#004E7A"},"favicon":"/favicon.png","logo":null,"api":{"playground":{"display":"simple"},"mdx":{"server":"http://localhost:3005","auth":{"method":"bearer","name":null}}},"background":{"image":"https://mintlify.s3-us-west-1.amazonaws.com/kiran/background.png","decoration":null},"navbar":{"links":[{"label":"GitHub","href":"https://github.com/devkiran/NextAPI"}],"primary":null},"footer":{"socials":{"github":"https://github.com/devkiran","website":"https://www.kirandev.com/"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kiran","hasAudioNarration":false,"actualSubdomain":"kiran","customDomains":[],"gitSource":{"type":"github","owner":"demo","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c3901b7c4331fd7379c8","collectionId":"4ed91e23-4896-4a3a-9c77-6e912a63df4e","schemaVersion":"v2"},"entitlements":{},"buildId":"6ae919bfe2896f3725202079:success","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Invitations","count":6},{"language":"default","tag":"Teams","count":5},{"language":"default","tag":"Members","count":3},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Auth","count":2},{"language":"default","tag":"API Documentation","count":1}]},"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":"rbac-expansion","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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"introduction","slug":"/introduction","pageMetadata":{"title":"Introduction","description":"NextAPI is a Next.js RESTful API Starter for building your next SaaS app","href":"/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: \"NextAPI is a Next.js RESTful API Starter for building your next SaaS app\"\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={li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`NextAPI handle the heavy lifting for common SaaS features such as authentication, team management, invites, subscriptions, and more.`}),`\n`,_jsx(_components.p,{children:`Say goodbye to tedious backend boilerplate code and focus on what matters most - building user-friendly UI/UX that delight your customers.`}),`\n`,_jsx(_components.p,{children:`With its powerful combination of Next.js, Supabase, and Prisma - NextAPI provides the perfect foundation for creating scalable and feature-rich SaaS apps.`}),`\n`,_jsx(Heading,{level:`2`,id:`built-with`,children:`Built With`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Next.js`}),`\n`,_jsx(_components.li,{children:`Supabase`}),`\n`,_jsx(_components.li,{children:`Prisma`}),`\n`,_jsx(_components.li,{children:`TypeScript`}),`\n`,_jsx(_components.li,{children:`React.email`}),`\n`]})]})}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":"Introduction","description":"NextAPI is a Next.js RESTful API Starter for building your next SaaS app","href":"/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Built With","slug":"built-with","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"kiran","siteName":"NextAPI","title":"Introduction - NextAPI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"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=\"NextAPI is a Next.js RESTful API Starter for building your next SaaS app\">\u003cmeta data-mint-head name=\"application-name\" content=\"NextAPI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kiran/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kiran/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kiran/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kiran/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - NextAPI\">\u003cmeta data-mint-head property=\"og:description\" content=\"NextAPI is a Next.js RESTful API Starter for building your next SaaS app\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"NextAPI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://kiran.mintlify.app/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kiran.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Introduction\u0026amp;description=NextAPI+is+a+Next.js+RESTful+API+Starter+for+building+your+next+SaaS+app\u0026amp;theme=99178f49227a32b217d40ba0\u0026amp;signature=b5d96b02bd80c751e963e1b4a01e9725b9e2f411f1d6103ce31017dd654126fc\">\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=\"Introduction - NextAPI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"NextAPI is a Next.js RESTful API Starter for building your next SaaS app\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kiran.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Introduction\u0026amp;description=NextAPI+is+a+Next.js+RESTful+API+Starter+for+building+your+next+SaaS+app\u0026amp;theme=99178f49227a32b217d40ba0\u0026amp;signature=b5d96b02bd80c751e963e1b4a01e9725b9e2f411f1d6103ce31017dd654126fc\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/kiran/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"NextAPI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#12A7D3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://kiran.mintlify.app/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://kiran.mintlify.app/#organization\",\"name\":\"NextAPI\",\"url\":\"https://kiran.mintlify.app\"},{\"@type\":\"WebSite\",\"@id\":\"https://kiran.mintlify.app#website\",\"name\":\"NextAPI\",\"url\":\"https://kiran.mintlify.app\",\"publisher\":{\"@id\":\"https://kiran.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://kiran.mintlify.app/introduction#webpage\",\"url\":\"https://kiran.mintlify.app/introduction\",\"name\":\"Introduction\",\"description\":\"NextAPI is a Next.js RESTful API Starter for building your next SaaS app\",\"isPartOf\":{\"@id\":\"https://kiran.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://kiran.mintlify.app/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://kiran.mintlify.app/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"NextAPI\",\"item\":\"https://kiran.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://kiran.mintlify.app/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://kiran.mintlify.app/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"NextAPI is a Next.js RESTful API Starter for building your next SaaS app\",\"url\":\"https://kiran.mintlify.app/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://kiran.mintlify.app/introduction#webpage\"},\"publisher\":{\"@id\":\"https://kiran.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://kiran.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"NextAPI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"NextAPI","nav":{"global":null,"groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","description":"Follow these steps to get started with NextAPI.","href":"/quickstart"},{"title":"Database Tables","href":"/tables"}]},{"group":"API Documentation","pages":[{"title":"Authentication","href":"/api-reference/authentication"}]},{"group":"Auth","pages":[{"title":"Sign in 3","api":"POST /api/auth/signin","href":"/api-reference/auth/signin"},{"title":"Sign up 1","api":"POST /api/auth/signup","href":"/api-reference/auth/signup"}]},{"group":"Teams","pages":[{"title":"Create a Team","api":"POST /api/teams","href":"/api-reference/teams/create"},{"title":"Get all teams","api":"GET /api/teams","href":"/api-reference/teams/get"},{"title":"Get a team","api":"GET /api/teams/{slug}","href":"/api-reference/teams/get-team"},{"title":"Update a team","api":"PUT /api/teams/{slug}","href":"/api-reference/teams/put"},{"title":"Delete a team","api":"DELETE /api/teams/{slug}","href":"/api-reference/teams/delete"}]},{"group":"Members","pages":[{"title":"Get members","api":"GET /api/teams/{slug}/members","href":"/api-reference/members/get"},{"title":"Update a member","api":"PUT /api/teams/{slug}/members/{memberId}","href":"/api-reference/members/put"},{"title":"Remove a member","api":"DELETE /api/teams/{slug}/members/{memberId}","href":"/api-reference/members/delete"}]},{"group":"Invitations","pages":[{"title":"Invite an user","api":"POST /api/teams/{slug}/invites","href":"/api-reference/invites/post"},{"title":"Get all invites","api":"GET /api/teams/{slug}/invites","href":"/api-reference/invites/get-all"},{"title":"Get an invite","api":"GET /api/teams/{slug}/invites/{id}","href":"/api-reference/invites/get"},{"title":"Delete an invite","api":"DELETE /api/teams/{slug}/invites/{id}","href":"/api-reference/invites/delete"},{"title":"Accept an invite","api":"POST /api/invites/{id}/accept","href":"/api-reference/invites/accept"},{"title":"Decline an invite","api":"POST /api/invites/{id}/decline","href":"/api-reference/invites/reject"}]}]},"basePath":"","title":"Introduction - NextAPI","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":[],"chunks":[]}