List threads

GET

/v1/email/threads

for await (const thread of bird.email.threads.list({ mailbox_id: "mbx_01abc" })) {
  console.log(thread.id, thread.subject);
}

for thread in client.email.threads.list(mailbox_id="mbx_01krdgeqcxet5s7t44vh8rt9mg"):
    print(thread.id, thread.subject)

for thread, err := range client.Email.Threads.List(context.Background(), bird.EmailThreadsListParams{}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(thread.Id)
}

foreach ($bird->email->threads->list(['mailbox_id' => 'mbx_01krdgeqcxet5s7t44vh8rt9mg']) as $thread) {
    echo $thread->getId(), ' ', $thread->getSubject(), "\n";
}

bird email threads list

curl -X GET "https://us1.platform.bird.com/v1/email/threads" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "labels=urgent" \
  --url-query "participant=billing@acme.com" \
  --url-query "subject=quarterly invoice" \
  --url-query "limit=25"

Risposta200

{
  "data": [
    {
      "id": "thr_01krdgeqcxet5s7t44vh8rt9mg",
      "mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
      "channel": "email",
      "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
      "subject": "Re: Your order",
      "participant_names": [
        {
          "address": "ada@example.com",
          "name": "Ada Lovelace"
        }
      ],
      "last_direction": "inbound",
      "folder": "inbox",
      "labels": [
        "urgent"
      ],
      "highlights": {
        "subject": [
          "Re: your **order** **4821**"
        ],
        "text": [
          "confirming your **order** **4821** shipped"
        ]
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns a paginated list of conversations across the workspace's mailboxes, most recently active first. folder selects inbox, archive, spam, blocked, sent, or trash. The default is inbox when neither folder nor custom labels are supplied. labels matches custom labels only; read_state=read|unread restricts read state. 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. Trashed conversations appear only with folder=trash. Expired trash never appears.

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

Parametri di query

mailbox_idstring

Filter to conversations in a mailbox by ID or email address in this workspace. An unknown or ambiguous email address returns 404; a valid mailbox ID with no matching threads returns an empty page.

contact_idstring

Filter to conversations linked to a specific contact.

folderstring

Filter to a folder. Defaults to inbox when neither folder nor custom labels are supplied.

Possible values: inbox, archive, spam, blocked, sent, trash

read_statestring

Filter to read or unread conversations. Omit for either state.

Possible values: read, unread

labelsarray

Match every listed custom label. Repeat labels to supply more than one. System label names are refused.

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

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

beforestring

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.

Payload di risposta

data

array of object

obbligatorio

Mostra attributi secondari

next_cursor

nullable string

obbligatorio

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

prev_cursor

nullable string

obbligatorio

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

refresh_cursor

nullable string

obbligatorio

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.

Continua con la documentazione, le guide e gli esempi per questo argomento.

Prova l'esercitazione e ottieni un brief di implementazione

for await (const thread of bird.email.threads.list({ mailbox_id: "mbx_01abc" })) {
  console.log(thread.id, thread.subject);
}

for thread in client.email.threads.list(mailbox_id="mbx_01krdgeqcxet5s7t44vh8rt9mg"):
    print(thread.id, thread.subject)

for thread, err := range client.Email.Threads.List(context.Background(), bird.EmailThreadsListParams{}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(thread.Id)
}

foreach ($bird->email->threads->list(['mailbox_id' => 'mbx_01krdgeqcxet5s7t44vh8rt9mg']) as $thread) {
    echo $thread->getId(), ' ', $thread->getSubject(), "\n";
}

bird email threads list

curl -X GET "https://us1.platform.bird.com/v1/email/threads" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "labels=urgent" \
  --url-query "participant=billing@acme.com" \
  --url-query "subject=quarterly invoice" \
  --url-query "limit=25"

Risposta200

{
  "data": [
    {
      "id": "thr_01krdgeqcxet5s7t44vh8rt9mg",
      "mailbox_id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
      "channel": "email",
      "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
      "subject": "Re: Your order",
      "participant_names": [
        {
          "address": "ada@example.com",
          "name": "Ada Lovelace"
        }
      ],
      "last_direction": "inbound",
      "folder": "inbox",
      "labels": [
        "urgent"
      ],
      "highlights": {
        "subject": [
          "Re: your **order** **4821**"
        ],
        "text": [
          "confirming your **order** **4821** shipped"
        ]
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

List threads

Parametri di query

Payload di risposta

Risorse correlate