email-threads

List threads

Returns a paginated list of conversations across the workspace's mailboxes, most recently active first. label selects the view: the inbox (the default when omitted), archive, spam, blocked, or any custom label. You can also filter by mailbox, by linked contact, by participant address, or by a subject substring.

This listing filters; it does not search message content. Conversations whose every message is trashed are excluded; restoring a message returns the conversation to the list.

before and after filter by time. To page through the results, pass the response cursors back as starting_after or ending_before.

get/v1/email/threads

Request

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

Query parameters

mailbox_idstring
Example:mbx_01krdgeqcxet5s7t44vh8rt9mg

Filter to conversations in a specific mailbox.

contact_idstring
Example:con_01krdgeqcxet5s7t44vh8rt9mg

Filter to conversations linked to a specific contact.

labelstring[]

Filter to conversations that have this label. Repeat the parameter to ask for more than one: only conversations that have every label you list are returned.

A placement label picks a folder: inbox, archive, spam, or blocked. A custom label matches a conversation in any folder. Leave this out and you get the inbox.

has_unreadboolean

When true, only conversations with unread messages are returned. This filters on the conversation's unread state, so you can combine it with label, for example to get unread conversations in the archive. The unread label itself lives on individual messages; this filter uses the conversation's aggregate unread state.

participantstring

Conversations involving this address, matching the sender or any recipient. The match is case-insensitive and matches on any part of the address, so a fragment works as well as the whole address.

subjectstring

Conversations whose subject contains this text (case-insensitive).

afterstring date-time

Filter to conversations whose most recent message is at or after this time. Use the response cursors for pagination.

beforestring date-time

Filter to conversations whose most recent message is at or before this time. Use the response cursors for pagination.

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 threads.

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": "thr_01krdgeqcxet5s7t44vh8rt9mg",
      "mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
      "channel": "email",
      "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
      "subject": "Re: Your order",
      "labels": [
        "inbox",
        "urgent"
      ],
      "highlights": {
        "subject": [
          "Re: your **order** **4821**"
        ],
        "text": [
          "confirming your **order** **4821** shipped"
        ]
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

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