HEhexclave
Emails

List email outbox

Changed on

Lists all emails in the outbox with optional filtering by status, simple_status, or user_id.

get/emails/outbox

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/emails/outbox
  • Auth
    none declared

Query parameters

statusstring
simple_statusstring
user_idstring

Filter for emails whose recipient is the given user ID.

limitstring

The maximum number of items to return. Maximum allowed is 100

cursorstring

The cursor to start the result set from (email ID)

Response

Successful response

itemsobject[] required

Example response

{
  "pagination": {
    "next_cursor": "b3d396b8-c574-4c80-97b3-50031675ceb2"
  }
}

Changes

  • c4c6162ab77fRevision changes
    • breaking

      the response property / became nullable for the status

    • warning

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

  • 7f10172f7332Revision changes
    • info

      added the new optional query request parameter user_id