Developer usage guide

API Documentation

Reference for platform API concepts, authentication expectations, request formats, and example endpoints used by the portal.

Contact Support Browse More

Session authentication

JSON request bodies

Role-aware endpoints

Invoice, project, and ticket APIs

Authentication

Most API routes require an authenticated session cookie. Mutation routes validate method, session role, and same-origin request context.

Projects

GET /api/platform-data returns scoped project, client, and invoice data. PATCH /api/projects/[id] updates project status or assignment for allowed roles.

Tasks

PATCH /api/tasks/[id] updates a single task by unique task ID and recalculates only its parent project progress.

Invoices

POST /api/invoices creates invoices for existing clients. GET /api/invoices/[id] returns a scoped invoice. GET /api/invoices/[id]/download returns a CSV invoice file.

Support

GET /api/tickets returns scoped support tickets. POST /api/tickets creates client requests. POST /api/tickets/[id]/messages appends replies.

API Examples

Create Invoice

POST /api/invoices

{ "client": "Client Partner", "amount": 25000, "status": "Pending", "dueDate": "2026-06-01" }

Update Task

PATCH /api/tasks/{taskId}

{ "completed": true }

Send Ticket Reply

POST /api/tickets/{ticketId}/messages

{ "body": "We are reviewing this request now." }