Flowless

Appearance

Getting Started ​

Get up and running with Flowless in under 5 minutes. This guide will walk you through creating your first Flowless instance and making your first API call.

🚀 Want to Skip the Setup?

Use our production-ready starter kits with Flowless authentication already integrated!

Full-Stack Starter Kits:

Both include Flowless auth + Flowfull backend + beautiful UI - ready to deploy! 🎉

👉 View All Starter Kits

Don't need to know the API? Use Flowfull Clients - Pre-built UI components and hooks that handle all the API calls for you! Perfect for developers who want to focus on building features, not authentication. 🎨

Prerequisites ​

Before you begin, make sure you have:

  • A Pubflow account (free to create)
  • Basic understanding of REST APIs
  • A tool to make HTTP requests (cURL, Postman, or your favorite HTTP client)

Step 1: Create a Flowless Instance ​

  1. Sign up or log in to Pubflow.com

  2. Navigate to the Dashboard

    • Click on "Create New Instance"
    • Select "Flowless" as the service type

  3. Configure your instance

    • Instance Name: Choose a unique name (e.g., my-app-auth)
    • Region: Select the region closest to your users
    • Plan: Start with the Free plan (up to 1,000 users)

  4. Create the instance

    • Click "Create Instance"
    • Wait 30-60 seconds for provisioning

  5. Get your instance URL

    • Your instance URL will be: https://your-instance-name.pubflow.com
    • Save this URL - you'll need it for all API calls

Step 2: Make Your First API Call ​

Let's register a new user using the Flowless API.

Using cURL ​

bash
curl -X POST https://your-instance-name.pubflow.com/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "SecurePassword123!",
    "name": "John",
    "last_name": "Doe"
  }'

Using JavaScript (Fetch) ​

javascript
const response = await fetch('https://your-instance-name.pubflow.com/auth/register', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: 'user@example.com',
    password: 'SecurePassword123!',
    name: 'John',
    last_name: 'Doe',
  }),
});

const data = await response.json();
console.log(data);

Expected Response ​

json
{
  "success": true,
  "data": {
    "user": {
      "id": "usr_1234567890",
      "email": "user@example.com",
      "name": "John",
      "last_name": "Doe",
      "is_verified": false,
      "created_at": "2025-12-07T10:00:00Z"
    },
    "session": {
      "session_id": "ses_abcdefghijk",
      "expires_at": "2025-12-14T10:00:00Z"
    }
  }
}

🎉 Congratulations! You've successfully created a user and received a session ID.

Step 3: Login a User ​

Now let's log in with the user we just created.

bash
curl -X POST https://your-instance-name.pubflow.com/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "SecurePassword123!"
  }'

Response ​

json
{
  "success": true,
  "data": {
    "user": {
      "id": "usr_1234567890",
      "email": "user@example.com",
      "name": "John",
      "last_name": "Doe",
      "is_verified": false
    },
    "session": {
      "session_id": "ses_xyz123456",
      "expires_at": "2025-12-14T10:00:00Z"
    }
  }
}

Step 4: Get Current User ​

Use the session ID to get the current authenticated user.

bash
curl -X GET https://your-instance-name.pubflow.com/auth/me \
  -H "X-Session-ID: ses_xyz123456"

Response ​

json
{
  "success": true,
  "data": {
    "id": "usr_1234567890",
    "email": "user@example.com",
    "name": "John",
    "last_name": "Doe",
    "is_verified": false,
    "created_at": "2025-12-07T10:00:00Z"
  }
}

Step 5: Configure Your Instance ​

Now that you have a working instance, let's configure it:

  1. Go to the Pubflow Dashboard
  2. Select your Flowless instance
  3. Configure settings:
    • Email provider (ZeptoMail)
    • Social OAuth providers (Google, Facebook, etc.)
    • Rate limiting rules
    • Custom branding

See Instance Configuration for detailed instructions.

Next Steps ​

Now that you have a working Flowless instance, here's what to do next:

🎨 Build Your Frontend

Connect your UI with Flowfull Clients - Pre-built libraries for React, Next.js, and React Native:

  • React: npm install @pubflow/react
  • React Native: npm install @pubflow/react-native
  • Next.js: npm install @pubflow/nextjs

Or use our Starter Kits for a complete full-stack app! 🚀

⚡ Build Your Backend

Need custom business logic? Build your backend with Flowfull - A production-ready backend framework that integrates seamlessly with Flowless authentication.

Get Started with Flowfull →

💳 Need Payments?

Add payment processing to your app with Bridge Payments - Supports Stripe, PayPal, Authorize.net, and more!

Explore Bridge Payments →

Learn the Basics ​

Explore the API ​

Integration Guides ​

Common Issues ​

"Instance not found" ​

  • Make sure you're using the correct instance URL
  • Check that your instance is active in the Pubflow dashboard

"Invalid credentials" ​

  • Verify the email and password are correct
  • Passwords must be at least 8 characters

"Rate limit exceeded" ​

  • You've made too many requests too quickly
  • Wait a few minutes and try again
  • See Rate Limiting for details

Need Help? ​

🌐 Explore the Pubflow Ecosystem ​

ServiceDescriptionLink
FlowlessManaged authentication serviceflowless.dev
FlowfullBackend frameworkflowfull.dev
Flowfull ClientsFrontend libraries & starter kitsclients.flowfull.dev
Bridge PaymentsUniversal payment backendbridgepayments.dev

💬 Community: Discord • 📧 Support: support@pubflow.com • 🐙 GitHub: github.com/pubflow