Skip to content

API Overview

Dispatch exposes a REST API at /api/v1/.

Base URL

EnvironmentURL
Productionhttps://api-dispatch.techtranslab.com

Authentication

Two authentication methods:

MethodHeaderUse Case
JWTAuthorization: Bearer {token}Dashboard, user management
API KeyX-API-Key: {key}Programmatic email/SMS sending

See Authentication for details.

Health Check

GET /health

Returns 200 OK when the service is healthy.

Error Format

json
{
  "error": "Human-readable error message"
}
CodeMeaning
200Success
201Created
400Bad request
401Unauthorized
403Forbidden
404Not found
429Rate limited
500Internal server error

Pagination

List endpoints support pagination:

GET /api/v1/messages?page=1&per_page=20

Response includes pagination metadata in the response body.

Swagger Docs

Interactive API documentation is available at:

  • https://api-dispatch.techtranslab.com/swagger/public/

TechTrans Lab