EmailController

Get all emails in all inboxes in paginated form. Email API list all.

Offset-style pagination endpoint for listing emails across inboxes. Supports inbox filters, unread-only, search, date boundaries, favourites, connector sync, plus-address filtering, and explicit include IDs.

get/emails/offset-paginated

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/emails/offset-paginated
  • Auth: API key in header x-api-key

Query parameters

inboxIdstring[]

Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.

pageinteger

Optional page index in email list pagination

sizeinteger

Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results

sort'ASC' | 'DESC'

Optional createdAt sort direction ASC or DESC

unreadOnlyboolean

Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly

searchFilterstring

Optional search filter. Matches email ID, inbox ID, sender address, subject, receiving inbox email address, receiving plus-address full address, or plus-address suffix. Pasted email address tokens are normalized before matching.

sincestring date-time

Optional filter emails received after given date time

beforestring date-time

Optional filter emails received before given date time

favouritedboolean

Optional filter emails that are favourited

syncConnectorsboolean

Sync connectors

plusAddressIdstring uuid

Optional plus address ID filter

includestring[]

Optional list of IDs to include in result

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.