Reference

API Reference

The Servelo REST API lets you integrate ticket and client data with external tools. All API requests are scoped to a tenant and require authentication.

⚠️ The API is currently in early access. Endpoints and response shapes may change. Full documentation is being expanded as the API stabilizes.

Authentication

The API uses JWT bearer tokens. Obtain a token by signing in:

POST /api/auth/login
Content-Type: application/json

{
  "email": "admin@yourdomain.com",
  "password": "your-password"
}

Include the returned token in all subsequent requests:

Authorization: Bearer <token>

Tenant resolution

The API resolves the tenant from the request hostname. Use your tenant subdomain as the base URL:

https://acme.serveloapp.com/api/...

Tickets

MethodEndpointDescription
GET/api/ticketsList all tickets
GET/api/tickets/:idGet a single ticket
POST/api/ticketsCreate a ticket
PUT/api/tickets/:idUpdate a ticket
GET/api/tickets/:id/commentsList comments on a ticket
POST/api/tickets/:id/commentsAdd a comment

Clients

MethodEndpointDescription
GET/api/customersList all clients
GET/api/customers/:idGet a single client
POST/api/customersCreate a client
PUT/api/customers/:idUpdate a client

Quotes

MethodEndpointDescription
GET/api/quotesList all quotes
GET/api/quotes/:idGet a single quote
POST/api/quotesCreate a quote
PUT/api/quotes/:idUpdate a quote

More endpoints

Full endpoint documentation for expenses, revenue, users, settings, and portal operations is coming soon. In the meantime, the server source is the authoritative reference.