Tenants

List all tenants

Changed on

List all tenants with pagination. Filter by status if needed.

get/tenants

Request

Query parameters

pageinteger

Page number (1-indexed)

perPageinteger

Number of items per page (max 100)

status'active' | 'suspended' | 'archived'

Filter by tenant status

Response

List of tenants

pageinteger required

Current page number (1-indexed)

perPageinteger required

Items per page

totalinteger required

Total number of tenants

totalPagesinteger required

Total number of pages

Example response

{
  "data": [
    {
      "id": "cm6abc123def456ghi789",
      "name": "Acme Corp",
      "metadata": {
        "plan": "pro",
        "internalId": "cust_12345"
      },
      "status": "active",
      "createdAt": "2026-02-03T10:30:00Z",
      "updatedAt": "2026-02-03T10:30:00Z"
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 42,
  "totalPages": 3,
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Changes

    • warning

      added the new infrastructure_error enum value to the / response property for the response status

    • warning

      added the new infrastructure_error enum value to the / response property for the response status

    • warning

      added the new infrastructure_error enum value to the / response property for the response status

    • warning

      added the new infrastructure_error enum value to the / response property for the response status

    • info

      removed the postal_error enum value from the / response property for the response status

    • info

      removed the postal_error enum value from the / response property for the response status

    • info

      removed the postal_error enum value from the / response property for the response status

    • info

      removed the postal_error enum value from the / response property for the response status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      added the new already_exists enum value to the / response property for the response status

    • warning

      added the new already_exists enum value to the / response property for the response status

    • warning

      added the new already_exists enum value to the / response property for the response status

    • warning

      added the new already_exists enum value to the / response property for the response status

    • warning

      added the new attachment_too_large enum value to the / response property for the response status

    • warning

      added the new attachment_too_large enum value to the / response property for the response status

    • warning

      added the new attachment_too_large enum value to the / response property for the response status

    • warning

      added the new attachment_too_large enum value to the / response property for the response status

    • warning

      added the new authentication_required enum value to the / response property for the response status

    • warning

      added the new authentication_required enum value to the / response property for the response status

    • warning

      added the new authentication_required enum value to the / response property for the response status

    • warning

      added the new authentication_required enum value to the / response property for the response status

    • warning

      added the new billing_error enum value to the / response property for the response status

    • warning

      added the new billing_error enum value to the / response property for the response status

    • warning

      added the new billing_error enum value to the / response property for the response status

    • warning

      added the new billing_error enum value to the / response property for the response status

    • warning

      added the new billing_not_configured enum value to the / response property for the response status

    • warning

      added the new billing_not_configured enum value to the / response property for the response status

    • warning

      added the new billing_not_configured enum value to the / response property for the response status

    • warning

      added the new billing_not_configured enum value to the / response property for the response status

    • warning

      added the new credential_not_found enum value to the / response property for the response status

    • warning

      added the new credential_not_found enum value to the / response property for the response status

    • warning

      added the new credential_not_found enum value to the / response property for the response status

    • warning

      added the new credential_not_found enum value to the / response property for the response status

    • warning

      added the new credential_on_hold enum value to the / response property for the response status

    • warning

      added the new credential_on_hold enum value to the / response property for the response status

    • warning

      added the new credential_on_hold enum value to the / response property for the response status

    • warning

      added the new credential_on_hold enum value to the / response property for the response status

    • warning

      added the new credential_revoked enum value to the / response property for the response status

    • warning

      added the new credential_revoked enum value to the / response property for the response status

    • warning

      added the new credential_revoked enum value to the / response property for the response status

    • warning

      added the new credential_revoked enum value to the / response property for the response status

    • warning

      added the new delivery_not_found enum value to the / response property for the response status

    • warning

      added the new delivery_not_found enum value to the / response property for the response status

    • warning

      added the new delivery_not_found enum value to the / response property for the response status

    • warning

      added the new delivery_not_found enum value to the / response property for the response status

    • warning

      added the new domain_already_exists enum value to the / response property for the response status

    • warning

      added the new domain_already_exists enum value to the / response property for the response status

    • warning

      added the new domain_already_exists enum value to the / response property for the response status

    • warning

      added the new domain_already_exists enum value to the / response property for the response status

    • warning

      added the new domain_not_found enum value to the / response property for the response status

    • warning

      added the new domain_not_found enum value to the / response property for the response status

    • warning

      added the new domain_not_found enum value to the / response property for the response status

    • warning

      added the new domain_not_found enum value to the / response property for the response status

    • warning

      added the new domain_not_verified enum value to the / response property for the response status

    • warning

      added the new domain_not_verified enum value to the / response property for the response status

    • warning

      added the new domain_not_verified enum value to the / response property for the response status

    • warning

      added the new domain_not_verified enum value to the / response property for the response status

    • warning

      added the new email_not_found enum value to the / response property for the response status

    • warning

      added the new email_not_found enum value to the / response property for the response status

    • warning

      added the new email_not_found enum value to the / response property for the response status

    • warning

      added the new email_not_found enum value to the / response property for the response status

    • warning

      added the new external_id_already_exists enum value to the / response property for the response status

    • warning

      added the new external_id_already_exists enum value to the / response property for the response status

    • warning

      added the new external_id_already_exists enum value to the / response property for the response status

    • warning

      added the new external_id_already_exists enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new idempotency_conflict enum value to the / response property for the response status

    • warning

      added the new idempotency_conflict enum value to the / response property for the response status

    • warning

      added the new idempotency_conflict enum value to the / response property for the response status

    • warning

      added the new idempotency_conflict enum value to the / response property for the response status

    • warning

      added the new insufficient_balance enum value to the / response property for the response status

    • warning

      added the new insufficient_balance enum value to the / response property for the response status

    • warning

      added the new insufficient_balance enum value to the / response property for the response status

    • warning

      added the new insufficient_balance enum value to the / response property for the response status

    • warning

      added the new internal_error enum value to the / response property for the response status

    • warning

      added the new internal_error enum value to the / response property for the response status

    • warning

      added the new internal_error enum value to the / response property for the response status

    • warning

      added the new internal_error enum value to the / response property for the response status

    • warning

      added the new invalid_api_key enum value to the / response property for the response status

    • warning

      added the new invalid_api_key enum value to the / response property for the response status

    • warning

      added the new invalid_api_key enum value to the / response property for the response status

    • warning

      added the new invalid_api_key enum value to the / response property for the response status

    • warning

      added the new invalid_email_address enum value to the / response property for the response status

    • warning

      added the new invalid_email_address enum value to the / response property for the response status

    • warning

      added the new invalid_email_address enum value to the / response property for the response status

    • warning

      added the new invalid_email_address enum value to the / response property for the response status

    • warning

      added the new invalid_raw_message enum value to the / response property for the response status

    • warning

      added the new invalid_raw_message enum value to the / response property for the response status

    • warning

      added the new invalid_raw_message enum value to the / response property for the response status

    • warning

      added the new invalid_raw_message enum value to the / response property for the response status

    • warning

      added the new invalid_request enum value to the / response property for the response status

    • warning

      added the new invalid_request enum value to the / response property for the response status

    • warning

      added the new invalid_request enum value to the / response property for the response status

    • warning

      added the new invalid_request enum value to the / response property for the response status

    • warning

      added the new ip_not_allowed enum value to the / response property for the response status

    • warning

      added the new ip_not_allowed enum value to the / response property for the response status

    • warning

      added the new ip_not_allowed enum value to the / response property for the response status

    • warning

      added the new ip_not_allowed enum value to the / response property for the response status

    • warning

      added the new message_too_large enum value to the / response property for the response status

    • warning

      added the new message_too_large enum value to the / response property for the response status

    • warning

      added the new message_too_large enum value to the / response property for the response status

    • warning

      added the new message_too_large enum value to the / response property for the response status

    • warning

      added the new metadata_key_invalid enum value to the / response property for the response status

    • warning

      added the new metadata_key_invalid enum value to the / response property for the response status

    • warning

      added the new metadata_key_invalid enum value to the / response property for the response status

    • warning

      added the new metadata_key_invalid enum value to the / response property for the response status

    • warning

      added the new metadata_too_large enum value to the / response property for the response status

    • warning

      added the new metadata_too_large enum value to the / response property for the response status

    • warning

      added the new metadata_too_large enum value to the / response property for the response status

    • warning

      added the new metadata_too_large enum value to the / response property for the response status

    • warning

      added the new metadata_value_invalid enum value to the / response property for the response status

    • warning

      added the new metadata_value_invalid enum value to the / response property for the response status

    • warning

      added the new metadata_value_invalid enum value to the / response property for the response status

    • warning

      added the new metadata_value_invalid enum value to the / response property for the response status

    • warning

      added the new missing_field enum value to the / response property for the response status

    • warning

      added the new missing_field enum value to the / response property for the response status

    • warning

      added the new missing_field enum value to the / response property for the response status

    • warning

      added the new missing_field enum value to the / response property for the response status

    • warning

      added the new missing_scope enum value to the / response property for the response status

    • warning

      added the new missing_scope enum value to the / response property for the response status

    • warning

      added the new missing_scope enum value to the / response property for the response status

    • warning

      added the new missing_scope enum value to the / response property for the response status

    • warning

      added the new not_found enum value to the / response property for the response status

    • warning

      added the new not_found enum value to the / response property for the response status

    • warning

      added the new not_found enum value to the / response property for the response status

    • warning

      added the new not_found enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payment_required enum value to the / response property for the response status

    • warning

      added the new payment_required enum value to the / response property for the response status

    • warning

      added the new payment_required enum value to the / response property for the response status

    • warning

      added the new payment_required enum value to the / response property for the response status

    • warning

      added the new postal_error enum value to the / response property for the response status

    • warning

      added the new postal_error enum value to the / response property for the response status

    • warning

      added the new postal_error enum value to the / response property for the response status

    • warning

      added the new postal_error enum value to the / response property for the response status

    • warning

      added the new rate_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new rate_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new rate_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new rate_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new send_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new send_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new send_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new send_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new server_suspended enum value to the / response property for the response status

    • warning

      added the new server_suspended enum value to the / response property for the response status

    • warning

      added the new server_suspended enum value to the / response property for the response status

    • warning

      added the new server_suspended enum value to the / response property for the response status

    • warning

      added the new service_unavailable enum value to the / response property for the response status

    • warning

      added the new service_unavailable enum value to the / response property for the response status

    • warning

      added the new service_unavailable enum value to the / response property for the response status

    • warning

      added the new service_unavailable enum value to the / response property for the response status

    • warning

      added the new suppressed_recipient enum value to the / response property for the response status

    • warning

      added the new suppressed_recipient enum value to the / response property for the response status

    • warning

      added the new suppressed_recipient enum value to the / response property for the response status

    • warning

      added the new suppressed_recipient enum value to the / response property for the response status

    • warning

      added the new suppression_not_found enum value to the / response property for the response status

    • warning

      added the new suppression_not_found enum value to the / response property for the response status

    • warning

      added the new suppression_not_found enum value to the / response property for the response status

    • warning

      added the new suppression_not_found enum value to the / response property for the response status

    • warning

      added the new tenant_not_found enum value to the / response property for the response status

    • warning

      added the new tenant_not_found enum value to the / response property for the response status

    • warning

      added the new tenant_not_found enum value to the / response property for the response status

    • warning

      added the new tenant_not_found enum value to the / response property for the response status

    • warning

      added the new too_many_attachments enum value to the / response property for the response status

    • warning

      added the new too_many_attachments enum value to the / response property for the response status

    • warning

      added the new too_many_attachments enum value to the / response property for the response status

    • warning

      added the new too_many_attachments enum value to the / response property for the response status

    • warning

      added the new too_many_recipients enum value to the / response property for the response status

    • warning

      added the new too_many_recipients enum value to the / response property for the response status

    • warning

      added the new too_many_recipients enum value to the / response property for the response status

    • warning

      added the new too_many_recipients enum value to the / response property for the response status

    • warning

      added the new unauthenticated_from_address enum value to the / response property for the response status

    • warning

      added the new unauthenticated_from_address enum value to the / response property for the response status

    • warning

      added the new unauthenticated_from_address enum value to the / response property for the response status

    • warning

      added the new unauthenticated_from_address enum value to the / response property for the response status

    • warning

      added the new unprocessable_entity enum value to the / response property for the response status

    • warning

      added the new unprocessable_entity enum value to the / response property for the response status

    • warning

      added the new unprocessable_entity enum value to the / response property for the response status

    • warning

      added the new unprocessable_entity enum value to the / response property for the response status

    • warning

      added the new validation_error enum value to the / response property for the response status

    • warning

      added the new validation_error enum value to the / response property for the response status

    • warning

      added the new validation_error enum value to the / response property for the response status

    • warning

      added the new validation_error enum value to the / response property for the response status

    • warning

      added the new webhook_not_found enum value to the / response property for the response status

    • warning

      added the new webhook_not_found enum value to the / response property for the response status

    • warning

      added the new webhook_not_found enum value to the / response property for the response status

    • warning

      added the new webhook_not_found enum value to the / response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status