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

Health check

Request

Returns the health status of the API service

curl -i -X GET \
  https://docs-staging.varmply.com/_mock/openapi/health

Responses

Service is healthy

Bodyapplication/json
statusstringrequired
Example: "ok"
Response
application/json
{
  "status": "ok"
}

Readiness probe

Request

Checks if the API service is ready to serve traffic by verifying database connectivity. Returns 200 if healthy, 503 if the database is unavailable.

curl -i -X GET \
  https://docs-staging.varmply.com/_mock/openapi/health/ready

Responses

Service is ready (database connected)

Bodyapplication/json
statusstringrequired
Example: "ok"
databasestringrequired
Example: "connected"
Response
application/json
{
  "status": "ok",
  "database": "connected"
}

Authentication

User registration and authentication

Operations

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