email-threads

List a mailbox's messages

Returns the messages in a mailbox across all of its conversations, newest first. By default only received messages in the inbox and all sent messages are returned. Pass label to see another view instead:

  • archive: Filed-away mail.
  • spam or blocked: Mail placed in either folder.
  • trash: Trashed messages.
  • unread: Messages you have not read yet, across all conversations.
  • Any custom label you have applied.

Filter by direction or combined delivery status. Pass include=extracted_text to inline each message's extracted plain text. before and after filter by time. To page through results, pass the response cursors back as starting_after or ending_before.

get/v1/email/mailboxes/{mailbox_id}/messages

Request

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

Query parameters

labelstring

Filter to messages that have this label. trash lists trashed messages. Any other label, whether that is archive, spam, blocked, unread or one of your own, lists the messages that have it and are not in the trash. When omitted, received messages in the inbox and all sent messages are returned.

direction'outbound' | 'inbound'

Whether a message was sent from the workspace (outbound) or received by it (inbound).

Filter to received (inbound) or sent (outbound) messages.

status'accepted' | 'sent' | 'delivered' | 'failed'

Filter sent messages by combined delivery status: accepted, sent, delivered, or failed.

afterstring date-time

Filter to messages that occurred at or after this time. Page through results with starting_after or ending_before instead of this value.

beforestring date-time

Filter to messages that occurred at or before this time. Page through results with starting_after or ending_before instead of this value.

include'extracted_text'

Set to extracted_text to inline each message's extracted plain text.

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 the mailbox's messages.

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",
      "channel": "email",
      "thread_id": "thr_01krdgeqcxet5s7t44vh8rt9mg",
      "subject": "Re: Your order",
      "labels": [
        "inbox",
        "unread"
      ],
      "attachment_manifest": [
        {
          "id": "rea_01krdgeqcxet5s7t44vh8rt9mg",
          "filename": "invoice.pdf",
          "content_type": "application/pdf"
        }
      ],
      "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
      "source": {
        "resource": "/v1/email/inbound-messages/rem_01krdgeqcxet5s7t44vh8rt9mg"
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

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