Response Format

All API responses use a consistent JSON wrapper.

Single resource

Endpoints that return a single object wrap it in data:

{
  "data": {
    "id": "abc123def456ghi789jkl01",
    "name": "Jane Smith",
    "email": "jane@example.com",
    "createdAt": "2025-06-15T09:30:00.000Z",
    "updatedAt": "2025-06-15T09:30:00.000Z"
  }
}

Lists

Endpoints that return multiple objects include a meta object with the total count:

{
  "data": [
    {
      "id": "abc123def456ghi789jkl01",
      "name": "Health Check",
      "status": "ACTIVE"
    }
  ],
  "meta": {
    "totalCount": 42
  }
}

meta.totalCount reflects the total number of records matching your filters, regardless of limit and offset. See Pagination for details.

Errors

Failed requests return an error object:

{
  "error": {
    "code": "not_found",
    "title": "Vitals Link not found"
  }
}

The HTTP status code indicates the error category. See Error Handling for the full list.