/api/v1API Documentation
Public / user API endpoints under /api/v1. Some endpoints require authentication or an API key.
Authentication
Include your API key in the request:
- Authorization header:
Authorization: Bearer <API_KEY> - Or header:
X-API-Key: <API_KEY> - Or query:
?api_key=<API_KEY>(not recommended)
Tip: request an API key from your administrator or manage your keys from the Dashboard.
My Organizations
List organizations the current user belongs to.
Get details for an organization the user belongs to.
Create a new organization (user becomes owner).
Update an organization you own or have permissions for.
Delete an organization you own.
Teams
List teams in an organization you belong to.
Get a team by ID.
Create a team within an organization you manage.
Update a team's details.
Delete a team.
Roles
List roles available in the organization.
Assign or update a user's role within an organization.
Affiliate
Get current user's affiliate info and stats.
List referrals and earnings.
Request affiliate payout/withdrawal.
Profile
Get the current user's profile data.
Update your profile information (name, avatar, settings).
Change your account password.
Subscriptions
List subscriptions. Query: search, per_page.
Get a subscription by ID.
Create a subscription.
Update a subscription.
Delete a subscription.
Payments
List payments. Query: search, per_page.
Get a payment by ID.
Create a payment.
Update a payment.
Delete a payment.