Sign Up

The signup endpoints allow new users to create accounts on the ProductFlo platform. Multiple registration methods are supported, including email, phone number, and OAuth providers.

POST /auth/signup

Create a new user account with email and password

Creates a new user account with email and password authentication.

Request

cURL
JavaScript
Python

curl -X POST https://api.productflo.io/auth/signup \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "username": "johndoe",
    "email": "john.doe@example.com",
    "password": "secure-password",
    "confirm_password": "secure-password"
  }'

const response = await fetch('https://api.productflo.io/auth/signup', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    first_name: 'John',
    last_name: 'Doe',
    username: 'johndoe',
    email: 'john.doe@example.com',
    password: 'secure-password',
    confirm_password: 'secure-password'
  }),
  credentials: 'include'
});

const data = await response.json();

import requests

response = requests.post(
    'https://api.productflo.io/auth/signup',
    json={
        'first_name': 'John',
        'last_name': 'Doe',
        'username': 'johndoe',
        'email': 'john.doe@example.com',
        'password': 'secure-password',
        'confirm_password': 'secure-password'
    }
)

data = response.json()

Request Body

string

The user’s first name

string

The user’s last name

string

The user’s full name (alternative to providing first_name and last_name separately)

string

required

The user’s username

string

required

The user’s email address

string

required

The user’s password

string

required

Confirmation of the password (must match password)

Response

object

User information

Show User properties

string

The user’s unique identifier

string

The audience the token is intended for

string

The user’s role (usually “authenticated”)

string

The user’s email address

string

Timestamp when the email was confirmed (or null if not confirmed)

object

User-specific metadata including profile information

Show User metadata properties

string

User’s first name

string

User’s last name

object

Session information if auto-login is enabled

{
  "first_name": "John",
  "last_name": "Doe",
  "username": "johndoe",
  "email": "john.doe@example.com",
  "password": "secure-password",
  "confirm_password": "secure-password"
}

{
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "aud": "authenticated",
    "role": "authenticated",
    "email": "john.doe@example.com",
    "email_confirmed_at": null,
    "phone": "",
    "confirmed_at": null,
    "last_sign_in_at": "2023-05-01T12:34:56.789Z",
    "app_metadata": {
      "provider": "email",
      "providers": ["email"]
    },
    "user_metadata": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "identities": [],
    "created_at": "2023-05-01T12:34:56.789Z",
    "updated_at": "2023-05-01T12:34:56.789Z"
  }
}

POST /auth/phone-signup

Create a new user account with phone number and password

Creates a new user account with phone number and password authentication.

Request

cURL
JavaScript

curl -X POST https://api.productflo.io/auth/phone-signup \
  -H "Content-Type: application/json" \
  -d '{
    "username": "johndoe",
    "phone_number": "+12345678901",
    "password": "secure-password",
    "confirm_password": "secure-password"
  }'

const response = await fetch('https://api.productflo.io/auth/phone-signup', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    username: 'johndoe',
    phone_number: '+12345678901',
    password: 'secure-password',
    confirm_password: 'secure-password'
  }),
  credentials: 'include'
});

const data = await response.json();

Request Body

string

required

The user’s username

string

required

The user’s phone number in international format (e.g., +12345678901)

string

required

The user’s password

string

required

Confirmation of the password (must match password)

Response

Similar to email signup response, with phone number instead of email.

POST /auth/provider

Create or login with an OAuth provider

Initiates the OAuth flow with an external provider like Google, GitHub, etc.

Request

cURL
JavaScript

curl -X POST https://api.productflo.io/auth/provider \
  -H "Content-Type: application/json" \
  -d '{
    "provider": "google"
  }'

const response = await fetch('https://api.productflo.io/auth/provider', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    provider: 'google'
  })
});

const data = await response.json();
// Redirect user to the provider URL
window.location.href = data.url;

Request Body

string

required

The OAuth provider to use (e.g., google, github, apple)

Response

string

URL to redirect the user to for OAuth authentication

{
  "provider": "google"
}

{
  "url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=..."
}

OAuth Callback

GET /auth/callback

Handle OAuth provider callback

This endpoint is called by the OAuth provider after the user authenticates. It completes the OAuth flow and creates or logs in the user.

Request

This endpoint is not typically called directly. The OAuth provider redirects to this URL with an authorization code.

GET /auth/callback?code=AUTHORIZATION_CODE&state=STATE

Response

After successful authentication, the user is redirected to the application with an authenticated session.

API Introduction

Authentication

Core Resources

File Management

AI Features

Integrations

WebSockets

Payments

POST /auth/signup

Request

Request Body

Response

POST /auth/phone-signup

Request

Request Body

Response

POST /auth/provider

Request

Request Body

Response

OAuth Callback

GET /auth/callback

Request

Response

​Sign Up API

​Email Signup

POST /auth/signup

​Request

​Request Body

​Response

​Phone Signup

POST /auth/phone-signup

​Request

​Request Body

​Response

​OAuth Provider Signup

POST /auth/provider

​Request

​Request Body

​Response

​OAuth Callback

GET /auth/callback

​Request

​Response

Sign Up API

Email Signup

Request

Request Body

Response

Phone Signup

Request

Request Body

Response

OAuth Provider Signup

Request

Request Body

Response

OAuth Callback

Request

Response