API Overview
Dispatch exposes a REST API at /api/v1/.
Base URL
| Environment | URL |
|---|---|
| Production | https://api-dispatch.techtranslab.com |
Authentication
Two authentication methods:
| Method | Header | Use Case |
|---|---|---|
| JWT | Authorization: Bearer {token} | Dashboard, user management |
| API Key | X-API-Key: {key} | Programmatic email/SMS sending |
See Authentication for details.
Health Check
GET /healthReturns 200 OK when the service is healthy.
Error Format
json
{
"error": "Human-readable error message"
}| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not found |
| 429 | Rate limited |
| 500 | Internal server error |
Pagination
List endpoints support pagination:
GET /api/v1/messages?page=1&per_page=20Response includes pagination metadata in the response body.
Swagger Docs
Interactive API documentation is available at:
https://api-dispatch.techtranslab.com/swagger/public/