Skip to main content
API Reference

Build with Underafoot

Comprehensive REST API for integrating Underafoot into your applications.

Quick Start

Base URL

text
https://api.underafoot.com/v1

Authentication

Most endpoints require authentication via Bearer token. Include the token in your request headers:

bash
curl -X GET "https://api.underafoot.com/v1/user" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Response Format

All responses are returned in JSON format. Successful responses include a 2xx status code. Error responses include a message and optional validation errors.

json
// Success Response
{
  "data": { ... },
  "message": "Operation successful."
}

// Error Response
{
  "message": "Validation failed.",
  "errors": {
    "email": ["The email field is required."]
  }
}

Rate Limiting

API requests are limited to 60 requests per minute for authenticated users and 20 requests per minute for unauthenticated requests. Rate limit headers are included in all responses.

Authentication

Endpoints for user authentication and session management.

POST/api/v1/auth/registerRegister a new user account
POST/api/v1/auth/loginAuthenticate user and receive token
POST/api/v1/auth/logoutLogout current session
POST/api/v1/auth/forgot-passwordRequest password reset email

User

Manage user profile and settings.

GET/api/v1/userGet current authenticated user
PUT/api/v1/user/profileUpdate user profile
POST/api/v1/user/avatarUpload profile avatar (multipart/form-data)
PUT/api/v1/user/passwordChange password

Creators

Public endpoints for browsing creators.

GET/api/v1/discovery/featuredGet featured creators
GET/api/v1/discovery/search?q={query}Search creators by name
GET/api/v1/creators/{username}Get public creator profile
GET/api/v1/creators/{username}/tiersGet creator subscription tiers

Subscriptions

Manage subscriptions to creators.

GET/api/v1/subscriber/subscriptionsList user subscriptions
POST/api/v1/subscriber/subscribeSubscribe to a creator
POST/api/v1/subscriber/subscriptions/{uuid}/cancelCancel a subscription
POST/api/v1/subscriber/subscriptions/{uuid}/resumeResume a cancelled subscription

Media Access

Access creator content with proper authorization.

GET/api/v1/subscriber/media/{uuid}/urlGet signed URL for media content
GET/api/v1/subscriber/media/{uuid}/thumbnailGet thumbnail URL
GET/api/v1/subscriber/media/{uuid}/previewGet preview clip URL

Creator Dashboard

Creator-only endpoints for managing content.

GET/api/v1/creator/dashboardGet dashboard statistics
GET/api/v1/creator/tiersList creator subscription tiers
POST/api/v1/creator/tiersCreate a new subscription tier
POST/api/v1/creator/mediaUpload new media content
GET/api/v1/creator/earningsGet earnings history
SDKs

Client Libraries

Official SDKs for popular languages (coming soon).

JavaScript/TypeScript
Coming Soon
Python
Coming Soon
PHP
Coming Soon
Ruby
Coming Soon

Need Help?

Check our comprehensive documentation or reach out to our developer support team.

View FeaturesContact Support