---
title: "List Inbound Emails"
method: GET
path: "/api/mailbox/"
tags: ["Mailbox"]
---

# List Inbound Emails

`GET /api/mailbox/`

## Request

- Base URL: `https://api.e-invoice.be`
- URL: `https://api.e-invoice.be/api/mailbox/`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/e-invoice-be/apis/e-invoice-be-peppol-access-point-api/docs/api/mailbox/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a paginated list of received inbound emails with filtering, search, and sorting options.

## Query parameters

- `page` integer: Page number
- `page_size` integer: Number of items per page
- `status` 'pending' | 'success' | 'failed'
- `processed` boolean, nullable: Filter by processing status. If not provided, returns all. Ignored when `status` is set.
- `received_from` string, date-time, nullable: Inclusive lower bound on received date (falls back to created_at when received_at is null)
- `received_to` string, date-time, nullable: Inclusive upper bound on received date (falls back to created_at when received_at is null)
- `search` string, nullable: Case-insensitive search across sender email, subject, message ID, and attachment filenames
- `sort_by` 'received_at' | 'created_at'
- `sort_order` 'asc' | 'desc': Sort order options.

## Response `200`

Successful Response

- PaginatedResponseInboundEmailResponse
  - `items` InboundEmailResponse[], required
    - `id` string, required
    - `message_id` string, required
    - `sender_email` string, required
    - `sender_name` string, nullable
    - `to_addresses` string, nullable
    - `cc_addresses` string, nullable
    - `bcc_addresses` string, nullable
    - `subject` string, nullable
    - `attachments` AttachmentInfo[]
      - `filename` string, required
      - `size` integer, nullable
      - `content_type` string, nullable
    - `attachment_count` integer
    - `processed` boolean
    - `error_message` string, nullable
    - `received_at` string, date-time, nullable
    - `created_at` string, date-time, required
    - `processed_at` string, date-time, nullable
    - `document_id` string, nullable
  - `total` integer, required
  - `page` integer, required
  - `page_size` integer, required
  - `pages` integer, required
  - `has_next_page` boolean, required

## Other responses

- `401`: Unauthorized: API key is missing, invalid, or inactive
- `422`: Validation Error
- `500`: Internal Server Error: Unexpected server error

## Changes

- **2026-10-11** `c75f35aa5f03`: 1 info
  - added the new optional `query` request parameter `status`
- **2026-10-11** `7563a8290e14`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/e-invoice-be/apis/e-invoice-be-peppol-access-point-api/changes/api/mailbox/get.md)

---

[API](https://skmtc.dev/e-invoice-be/apis/e-invoice-be-peppol-access-point-api.md) - [All operations](https://skmtc.dev/e-invoice-be/apis/e-invoice-be-peppol-access-point-api/llms.txt) - [OpenAPI document](https://skmtc.dev/e-invoice-be/apis/e-invoice-be-peppol-access-point-api/revisions/0ee5e3d3992a?raw)
