InboxController

List Inboxes and email addresses

List the inboxes you have created. Note use of the more advanced getAllInboxes is recommended and allows paginated access using a limit and sort parameter.

get/inboxes

Request

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

Query parameters

sizeinteger

Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated getAllEmails for larger queries.

sort'ASC' | 'DESC'

Optional createdAt sort direction ASC or DESC

sincestring date-time

Optional filter by created after given date time

excludeCatchAllInboxesboolean

Optional exclude catch all inboxes

beforestring date-time

Optional filter by created before given date time

includestring[]

Optional inboxIds to include in result

Response

OK

Changes

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