Skip to content

Varmply Backend API (0.1.0)

Varmply API – MVP backend for campaigns, wallets, authentication, and influencer participation.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs-staging.varmply.com/_mock/openapi/
Local development server
http://localhost:3000/
Staging environment
https://api-staging.varmply.com/
Production environment
https://api.varmply.com/

Health

Health check endpoints

Operations

Authentication

User registration and authentication

Operations

Register a new user

Request

Register a new user account with email and password. Returns JWT tokens upon successful registration.

Bodyapplication/jsonrequired
emailAddressstring(email)required

Valid email address

Example: "founder@example.com"
passwordstring(password)>= 8 charactersrequired

Password must be at least 8 characters long

Example: "strongpassword123"
curl -i -X POST \
  https://docs-staging.varmply.com/_mock/openapi/auth/register \
  -H 'Content-Type: application/json' \
  -d '{
    "emailAddress": "founder@example.com",
    "password": "strongpassword123"
  }'

Responses

User registered successfully

Bodyapplication/json
accessTokenstringrequired

JWT access token (expires in 15 minutes)

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
refreshTokenstringrequired

JWT refresh token (expires in 30 days)

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
Response
application/json
{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Login with email and password

Request

Authenticate an existing user and receive JWT tokens

Bodyapplication/jsonrequired
emailAddressstring(email)required

Registered email address

Example: "founder@example.com"
passwordstring(password)required

User password

Example: "strongpassword123"
curl -i -X POST \
  https://docs-staging.varmply.com/_mock/openapi/auth/login \
  -H 'Content-Type: application/json' \
  -d '{
    "emailAddress": "founder@example.com",
    "password": "strongpassword123"
  }'

Responses

Login successful

Bodyapplication/json
accessTokenstringrequired

JWT access token (expires in 15 minutes)

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
refreshTokenstringrequired

JWT refresh token (expires in 30 days)

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
Response
application/json
{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Wallet

Wallet balance and operations

Operations

Dev

Development-only endpoints for testing (not available in production)

Operations

Campaigns

Campaign creation, management, and funding

Operations

Participation

Campaign participation and content submission

Operations

OAuth

Social media OAuth connection flows

Operations

Metrics

Content metrics and analytics endpoints

Operations