NTOMA API Documentation

REST API for NTOMA Web Application

App

• GET
  Liveness probe/health

Auth

• POST
  This endpoint is only to be used on the register page/api/auth/register
• POST
  This endpoint is to be used after creating account to verify the email used before access to the system/api/auth/verify-email
• POST
  This endpoint is only to be used on the forgot password page to request a password reset/api/auth/request-password-reset
• POST
  Changes the user password on the reset-password page. Side effect: a successful reset REVOKES ALL of the user’s existing sessions — every other device will get 401 on its next refresh and must re-login./api/auth/reset-password
• GET
  This endpoint is only to be used on the reset password page but before loading the screen to verify if the token provided by the user is valid or not/api/auth/verify-token
• POST
  This endpoint is only to be used when a user wants to login/api/auth/login
• GET
  Begin Google OAuth sign-in/api/auth/google
• GET
  Google OAuth callback — redirects to the SPA with a single-use code/api/auth/google/callback
• GET
  Begin GitHub OAuth sign-in/api/auth/github
• GET
  GitHub OAuth callback — redirects to the SPA with a single-use code/api/auth/github/callback
• POST
  Exchanges the one-time code from the OAuth success redirect (?code=...) for a session. The code is single-use and expires in ~60s. Returns the same shape as login. Replaces returning tokens directly in the OAuth redirect URL./api/auth/oauth/exchange
• GET
  This endpoint is only to be used to get the authenticated user/api/auth/user
• POST
  POST the current refresh token in the body to receive a NEW access token and a ROTATED refresh token. The presented refresh token is single-use and immediately revoked — the client must persist the returned refreshToken. (Replaces the old GET + `ref-tk` header contract.)/api/auth/refresh-token
• POST
  Revokes the session for the supplied refresh token. Idempotent — always returns 200, even for an invalid or expired token, so token validity is never disclosed./api/auth/logout

Profile

• GET
  Get the signed-in user profile and their activity totals/api/auth/user/profile
• PATCH
  Update the signed-in user profile/api/auth/user/profile
• POST
  Start an avatar upload/api/auth/user/avatar-upload
• POST
  Finish an avatar upload/api/auth/user/avatar-upload/complete

Plan

• GET
  Get all plans/api/plan

Timeline

• GET
  Get the caller sign-in history/api/timeline/logins
• GET
  Get the caller per-day action counts/api/timeline/activity-summary
• GET
  Get a user activity logs/api/timeline/user
• GET
  Get all activity logs (admin)/api/timeline
• GET
  Get logs for a specific resource (admin)/api/timeline/resource/{type}/{id}
• GET
  Get action summary counts (admin)/api/timeline/summary

Organization

• GET
  List organizations the caller belongs to/api/organizations
• POST
  Create an organization/api/organizations
• GET
  Retrieve an invitation by token/api/organizations/invitations/{token}
• POST
  Accept an organization invitation/api/organizations/invitations/{token}/accept
• GET
  Retrieve an organization by id/api/organizations/{id}
• PATCH
  Rename an organization/api/organizations/{id}
• GET
  List organization members/api/organizations/{id}/members
• POST
  Invite a member to the organization/api/organizations/{id}/invitations
• DELETE
  Revoke a pending invitation/api/organizations/{id}/invitations/{invitationId}
• DELETE
  Remove a member from the organization/api/organizations/{id}/members/{memberId}
• PATCH
  Update a member's role or status/api/organizations/{id}/members/{memberId}

Collection

• POST
  This endpoint is used to create a collection for a user/api/collections/create
• GET
  Get all collections belonging to a user/api/collections
• GET
  Get a single collection by its ID/api/collections/{id}
• DELETE
  Delete a collection by its ID/api/collections/{id}
• PATCH
  Update the title of a collection/api/collections/{id}
• PATCH
  Favorite or unfavorite a collection/api/collections/{id}/favorite

Asset

• GET
  List assets in the current scope/api/assets
• GET
  Get a presigned download URL for an asset/api/assets/{id}/download
• POST
  Publish a personal asset into the organization/api/assets/{id}/publish
• PATCH
  Favorite or unfavorite an asset/api/assets/{id}/favorite
• GET
  Get asset details by ID/api/assets/{id}
• DELETE
  Delete an asset by its ID/api/assets/{id}
• PATCH
  Update an asset/api/assets/{id}
• GET
  Retrieve the caller's asset activity logs/api/assets/logs
• GET
  Retrieve assets belonging to a specific collection/api/assets/collection/{collectionId}
• GET
  Retrieve activity logs for a single asset/api/assets/{id}/asset-logs
• GET
  Retrieve all versions of an asset/api/assets/{id}/versions
• PATCH
  Restore a specific version of an asset/api/assets/{id}/versions/restore/{versionNumber}

Upload

• POST
  Initiate a multipart upload to S3/api/upload/initiate
• POST
  Complete multipart upload and save asset metadata/api/upload/complete
• POST
  Abort an active multipart upload/api/upload/abort

Project

• GET
  List the active organization projects/api/projects
• POST
  Create a project in the active organization/api/projects
• GET
  Get one project with its counts and members/api/projects/{id}
• DELETE
  Soft-delete a project/api/projects/{id}
• PATCH
  Update a project/api/projects/{id}
• PATCH
  Move a project to a board column and position/api/projects/{id}/position

ProjectComment

• GET
  List a project comment thread, oldest first/api/projects/{projectId}/comments
• POST
  Post a comment on a project/api/projects/{projectId}/comments
• DELETE
  Soft-delete a comment/api/projects/{projectId}/comments/{commentId}
• PATCH
  Edit a comment/api/projects/{projectId}/comments/{commentId}

Task

• GET
  List the active organization tasks/api/tasks
• GET
  List one project of tasks/api/projects/{projectId}/tasks
• POST
  Create a task in a project/api/projects/{projectId}/tasks
• GET
  Get one task/api/tasks/{id}
• DELETE
  Soft-delete a task/api/tasks/{id}
• PATCH
  Update a task/api/tasks/{id}
• PATCH
  Move a task to a status and board position/api/tasks/{id}/position
• PUT
  Replace a task assignees/api/tasks/{id}/assignees
• GET
  List the assets linked to a task/api/tasks/{taskId}/assets
• PUT
  Replace the assets linked to a task/api/tasks/{taskId}/assets

TaskComment

• GET
  List a task comment thread/api/tasks/{taskId}/comments
• POST
  Post a comment on a task/api/tasks/{taskId}/comments
• DELETE
  Soft-delete a comment/api/tasks/{taskId}/comments/{commentId}
• PATCH
  Edit a comment/api/tasks/{taskId}/comments/{commentId}

Dashboard

• GET
  Summarize the active organization for the Home page/api/dashboard/summary