Responses and pagination

Qboxmail APIs return different response formats depending on which API you use.

Management API responses

Most Management API responses look like this:

{
  "resources": [],
  "pagination": {}
}

For list endpoints, resources contains the current page of items and pagination contains navigation metadata.

{
  "resources": [
    {
      "code": "DD66042061",
      "name": "example.com"
    }
  ],
  "pagination": {
    "per": 25,
    "page": 1,
    "total_pages": 1,
    "query": null,
    "filter": null,
    "status": null,
    "sort_field": null,
    "sort": null,
    "total_records": 1
  }
}

For single-resource endpoints, resources usually contains one item. For delete operations, the response may be 204 No Content.

Pagination parameters

Common list endpoints support some or all of these query parameters:

Always check the endpoint reference for the exact filters supported by each resource.

Send API responses

The Send API does not paginate /v1/send or /v1/send/bulk responses. It returns the messages accepted in that request.

These responses require a Send API token from an existing Delivery account. If the Delivery account, sending domain, or token is missing, fix that setup before expecting accepted-message responses.

{
  "error_code": 0,
  "message": "OK",
  "request_id": "f43eb659-beb4-4f8a-a737-2d403998f4cf",
  "queued_messages": 1,
  "messages": [
    {
      "error_code": 0,
      "message": "OK",
      "request_id": "f43eb659-beb4-4f8a-a737-2d403998f4cf",
      "message_id": "8a16f3df-7f5f-4e53-a7e7-3e665ef57c51@example.test",
      "submitted_at": "2026-04-16T08:41:13.225Z",
      "to": "john@example.com"
    }
  ],
  "suppression_summary": {
    "status": "checked",
    "checked_recipients": 1,
    "accepted_recipients": 1,
    "suppressed_recipients": 0,
    "suppressed_emails": []
  }
}

Field naming

Public request and response fields use snake_case.

Examples:

• request_id
• message_id
• queued_messages
• suppression_summary
• total_records