1. Home
  2. Docs
  3. Managers
  4. API Documentation
  5. Response envelope

Response envelope

Published 26 January 2026, Updated 26 January 2026

Most endpoints return:

All responses are JSON (Content-Type: application/json), including errors (except the bare {"error":"unauthorized"} body which is still JSON without the envelope).

{
  "meta": {
    "time": "2026-01-01T00:00:00+00:00",
    "env": "prod",
    "version": "v1",
    "endpoint": "users",
    "action": "list",
    "error": null,
    "status": 200,
    "timezone": "America/Toronto"
  },
  "data": {}
}

Notes:

  • If the payload contains error, it is copied into meta.error.
  • Missing or invalid tokens return a bare body: {"error":"unauthorized"} (no envelope).
  • Errors are exposed in meta.error (and sometimes in data.error when the payload includes it).
  • meta.version reports the API version used for the request.
Was this article helpful to you? Yes No