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
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/tickets | List all tickets |
| GET | /api/tickets/:id | Get a single ticket |
| POST | /api/tickets | Create a ticket |
| PUT | /api/tickets/:id | Update a ticket |
| GET | /api/tickets/:id/comments | List comments on a ticket |
| POST | /api/tickets/:id/comments | Add a comment |
Clients
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/customers | List all clients |
| GET | /api/customers/:id | Get a single client |
| POST | /api/customers | Create a client |
| PUT | /api/customers/:id | Update a client |
Quotes
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/quotes | List all quotes |
| GET | /api/quotes/:id | Get a single quote |
| POST | /api/quotes | Create a quote |
| PUT | /api/quotes/:id | Update 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.