DEVELOPERS

REST API for
programmatic access.

Automate invoice fetching, ticket creation, and subscription management. Bearer token auth. JSON in, JSON out.

QUICK START

1. Get a token

Exchange your client portal email and password for a Bearer token.

curl -X POST https://www.clustrixglobal.com/api/v1/auth/token \
  -H "Accept: application/json" \
  -d "email=you@company.com&password=••••••&name=My laptop"

Response:

{
  "token": "2|abc123xyz...",
  "token_name": "My laptop",
  "user": { "id": 7, "email": "you@company.com", "client_id": 4, "client_name": "Acme Corp" }
}

2. Call an endpoint

curl https://www.clustrixglobal.com/api/v1/invoices \
  -H "Authorization: Bearer 2|abc123xyz..." \
  -H "Accept: application/json"
AUTH & USER
POST /api/v1/auth/token Exchange email+password for token. Public.
POST /api/v1/auth/revoke Revoke the current token.
GET /api/v1/me Authenticated user profile.
INVOICES
GET /api/v1/invoices List invoices (paginated). Query: ?status=&per_page=
GET /api/v1/invoices/{id} Invoice detail with line items and payments.
GET /api/v1/invoices/{id}/pdf Download branded PDF.
TICKETS
GET /api/v1/tickets List support tickets.
GET /api/v1/tickets/{id} Detail with full reply thread.
POST /api/v1/tickets Open new ticket. body: subject, body, priority, category.
POST /api/v1/tickets/{id}/reply Reply to ticket. body: body.
SUBSCRIPTIONS
GET /api/v1/subscriptions List active subscriptions.
POST /api/v1/subscriptions/{id}/pause Pause. body: resume_at (optional).
POST /api/v1/subscriptions/{id}/resume Resume a paused subscription.
POST /api/v1/subscriptions/{id}/cancel Cancel. body: reason (optional).
ERRORS

All errors return JSON with message and (for validation) errors.

  • 401 — missing or invalid token
  • 403 — token is valid but lacks permission (e.g. accessing another client's invoice)
  • 404 — resource not found
  • 422 — validation failed
  • 429 — rate limit exceeded
  • 500 — server error (we get paged; you don't need to retry forever)

Need an endpoint that's not here?

Open a ticket via the portal or email developers@clustrixglobal.com — we'll build it.