HyperSaaS
BackendWorkspaces & Teams

API Endpoints

REST API for managing workspaces, teams, and memberships.

Workspaces

MethodEndpointDescription
GET/api/workspaces/List user's workspaces
POST/api/workspaces/Create a workspace
GET/api/workspaces/{id}/Retrieve workspace
PUT/api/workspaces/{id}/Update workspace
DELETE/api/workspaces/{id}/Delete workspace

Create Workspace

POST /api/workspaces/
{
  "name": "My Project"
}

The slug is auto-generated from the name. The authenticated user becomes the owner.

Teams

MethodEndpointDescription
GET/api/teams/List teams
POST/api/teams/Create a team
GET/api/teams/{id}/Retrieve team
PUT/api/teams/{id}/Update team
DELETE/api/teams/{id}/Delete team

Workspace Memberships

MethodEndpointDescription
GET/api/workspacememberships/List memberships
POST/api/workspacememberships/Add member
GET/api/workspacememberships/{id}/Retrieve membership
PUT/api/workspacememberships/{id}/Update role
DELETE/api/workspacememberships/{id}/Remove member

Team Memberships

MethodEndpointDescription
GET/api/teammemberships/List team memberships
POST/api/teammemberships/Add team member
PUT/api/teammemberships/{id}/Update role
DELETE/api/teammemberships/{id}/Remove from team

User Endpoints

MethodEndpointDescription
GET/api/users/List users (filtered to self)
GET/api/users/me/Current user with credit info
GET/api/users/credit-usage/Credit usage percentage

On this page