Skip to main content

Endpoints

This section lists all available API endpoints, organized by controllers.


Auth Endpoints

MethodPathDescriptionAuth RequiredRole Required
GET/api/auth/sessionVerifies the user's JWT sessionNo, but will fail if no user cookies present.None
GET/api/auth/refreshRotates and issues new tokensNo, but will fail if no user cookies present.None

Boss Endpoints

MethodPathDescriptionAuth RequiredRole Required
GET/api/boss/:idGet all bosses for a worldYesNone
PATCH/api/boss/:idUpdate killed state for a bossYesOwner, Admin, Sub Admin

Event Endpoints

MethodPathDescriptionAuth RequiredRole Required
POST/api/event/:idCreate an event for the user's worldYesNone
POST/api/event/join/:idAllows user to join a world eventYesNone
GET/api/event/:idGets all events for a worldYesNone
DELETE/api/event/:idDeletes an eventYesNone

Note Endpoints

MethodPathDescriptionAuth RequiredRole Required
POST/api/note/:idCreates a note for a worldYesNone
GET/api/note/:idAll notes for a worldYesNone
DELETE/api/note/:idDeletes a note from a worldYesOwner, Admin, Sub Admin

User Endpoints

MethodPathDescriptionAuth RequiredRole Required
POST/api/user/signupRegister a new userNoNone
POST/api/user/signinSign in and receive JWT and refresh tokens via httpOnly cookiesNoNone
POST/api/user/signoutSign out userYesNone
GET/api/user/fetchUserByIdGet user information by their idYesNone

World Endpoints

MethodPathDescriptionAuth RequiredRole Required
POST/api/world/createCreates a worldYesNone
POST/api/world/joinJoins a worldYesNone
GET/api/world/Gets all worlds a user is a part ofYesNone
GET/api/world/adminData/:idGet admin data for a worldYesOwner, Admin, Sub Admin
PATCH/api/world/:idUpdate data for a worldYesOwner

World Membership Endpoints

MethodPathDescriptionAuth RequiredRole Required
GET/api/membership/all/:idAll members in a worldYesNone
GET/api/membership/:idMembership role in a worldYesNone
PATCH/api/membership/:idUpdate membership for someone in a worldYesOwner

Tip:
For details, parameters, and examples, see the controller and routes documentation for each section.