Login

The login endpoints allow users to authenticate with the ProductFlo API and obtain access tokens for subsequent API calls.

POST /auth/login

Authenticate a user with email and password

Authenticates a user with their email and password, returning a session with access and refresh tokens.

Request

cURL
JavaScript
Python

curl -X POST https://api.productflo.io/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "your-password"
  }'

const response = await fetch('https://api.productflo.io/auth/login', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: 'user@example.com',
    password: 'your-password',
  }),
  credentials: 'include' // Important for cookie-based auth
});

const data = await response.json();

import requests

response = requests.post(
    'https://api.productflo.io/auth/login',
    json={
        'email': 'user@example.com',
        'password': 'your-password'
    }
)

data = response.json()

Request Body

string

required

The user’s email address

string

required

The user’s password

Response

object

User information

Show User properties

string

The user’s unique identifier

object

Metadata about the user’s account

object

User-specific metadata including profile information

string

The audience the token is intended for

string

The user’s email address

object

Session information

Show Session properties

string

JWT token for API access

string

Token used to refresh the access token

number

Number of seconds until the token expires

string

Type of token (usually “bearer”)

{
  "email": "user@example.com",
  "password": "your-password"
}

{
  "user": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "aud": "authenticated",
    "role": "authenticated",
    "email": "user@example.com",
    "email_confirmed_at": "2023-01-01T12:00:00.000Z",
    "phone": "",
    "confirmed_at": "2023-01-01T12:00:00.000Z",
    "last_sign_in_at": "2023-05-01T12:34:56.789Z",
    "app_metadata": {
      "provider": "email",
      "providers": ["email"]
    },
    "user_metadata": {
      "first_name": "John",
      "last_name": "Doe",
      "avatar_url": "https://example.com/avatar.jpg"
    },
    "identities": [],
    "created_at": "2023-01-01T12:00:00.000Z",
    "updated_at": "2023-05-01T12:34:56.789Z"
  },
  "session": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "bearer",
    "expires_in": 3600,
    "refresh_token": "aBcDeFgHiJkLmNoPqRsTuVwXyZ..."
  }
}

POST /auth/phone-login

Authenticate a user with phone number and password

Authenticates a user with their phone number and password, returning a session with access and refresh tokens.

Request

cURL
JavaScript

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

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

const data = await response.json();

Request Body

string

required

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

string

required

The user’s password

Response

Same structure as the email login response.

Magic Link Authentication

POST /auth/magic-link

Send a magic link to the user’s email for passwordless login

Sends a magic link to the user’s email address for passwordless authentication.

Request

cURL
JavaScript

curl -X POST https://api.productflo.io/auth/magic-link \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com"
  }'

const response = await fetch('https://api.productflo.io/auth/magic-link', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: 'user@example.com',
  })
});

const data = await response.json();

Request Body

string

required

The user’s email address

Response

string

Confirmation message

{
  "email": "user@example.com"
}

{
  "message": "Magic link sent to email"
}

OTP Authentication

POST /auth/phone-otp

Send a one-time password to the user’s phone

Sends a one-time password (OTP) to the user’s phone number for authentication.

Request

cURL

curl -X POST https://api.productflo.io/auth/phone-otp \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+12345678901"
  }'

Request Body

string

required

The user’s phone number in international format

Response

string

Confirmation message

{
  "phone_number": "+12345678901"
}

{
  "message": "OTP sent to phone number"
}

Verify OTP

POST /auth/verify-phone-otp

Verify a one-time password sent to the user’s phone

Verifies the one-time password (OTP) sent to the user’s phone number.

Request

cURL

curl -X POST https://api.productflo.io/auth/verify-phone-otp \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+12345678901",
    "token": "123456"
  }'

Request Body

string

required

The user’s phone number in international format

string

required

The OTP code received by the user

Response

Same structure as the login response, containing user and session information.

API Introduction

Authentication

Core Resources

File Management

AI Features

Integrations

WebSockets

Payments

POST /auth/login

Request

Request Body

Response

POST /auth/phone-login

Request

Request Body

Response

Magic Link Authentication

POST /auth/magic-link

Request

Request Body

Response

OTP Authentication

POST /auth/phone-otp

Request

Request Body

Response

Verify OTP

POST /auth/verify-phone-otp

Request

Request Body

Response

​Login API

​Email Login

POST /auth/login

​Request

​Request Body

​Response

​Phone Login

POST /auth/phone-login

​Request

​Request Body

​Response

​Magic Link Authentication

POST /auth/magic-link

​Request

​Request Body

​Response

​OTP Authentication

POST /auth/phone-otp

​Request

​Request Body

​Response

​Verify OTP

POST /auth/verify-phone-otp

​Request

​Request Body

​Response

Login API

Email Login

Request

Request Body

Response

Phone Login

Request

Request Body

Response

Magic Link Authentication

Request

Request Body

Response

OTP Authentication

Request

Request Body

Response

Verify OTP

Request

Request Body

Response