email-inbound-messages

List received emails

Returns a paginated list of received emails for the workspace, newest first. Filter by sender address, by the inbound address or mailbox that received the mail, or by a received-time range. Mail a mailbox received is listed whatever its placement, including spam and blocked mail, with its mailbox_id and, while the mailbox keeps it, its thread_id. Received emails are retained for 30 days.

get/v1/email/inbound-messages

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/inbound-messages
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

fromstring email

Filter to messages whose sender address matches this value exactly. Sender addresses are stored lowercase, so pass the address in lowercase to match reliably.

inbound_address_idstring
Example:ina_01krdgeqcxet5s7t44vh8rt9mg

Filter to messages received on a specific inbound address.

mailbox_idstring
Example:mbx_01krdgeqcxet5s7t44vh8rt9mg

Filter to messages received by a specific mailbox.

received_afterstring date-time

Filter to messages received at or after this time.

received_beforestring date-time

Filter to messages received at or before this time.

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Paginated list of received emails.

next_cursorstring nullable required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursorstring nullable required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursorstring nullable required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Example response

{
  "data": [
    {
      "id": "rem_01krdgeqcxet5s7t44vh8rt9mg",
      "from": {
        "email": "jane@acme.com",
        "name": "Jane Doe"
      },
      "to": [
        {
          "email": "jane@acme.com",
          "name": "Jane Doe"
        }
      ],
      "cc": [
        {
          "email": "jane@acme.com",
          "name": "Jane Doe"
        }
      ],
      "subject": "Re: Your receipt",
      "message_id": "<CAH+T8d5...@mail.gmail.com>",
      "in_reply_to": "<previous-message@example.com>",
      "mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
      "attachments": [
        {
          "id": "rea_01krdgeqcxet5s7t44vh8rt9mg",
          "filename": "invoice.pdf",
          "content_type": "application/pdf",
          "size": 215432
        }
      ]
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.