How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bird Email Threads API

Conversations in a mailbox. Threads group related inbound and outbound messages and carry read state, labels, and participants.

Bird Email Threads API is one of 65 APIs that Bird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Email Threads. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 16 operations across 11 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.

16 operations 11 paths 31 schemas 2 DELETE10 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.bird.com
Authentication
HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Bird Email Threads API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the cookie as bird_session (CookieAuth). An API key is passed in the header as X-Realtime-Key (RealtimeKey). An API key is passed in the header as X-Realtime-Secret (RealtimeSecret). By default, every request must be authenticated.

  • BearerAuth — Pass the API key as a bearer token in the Authorization header. Keys use the format bk{region}. The prefix identifies the region and selects the API endpoint.…
  • CookieAuth — Session cookie set after signing in to the Bird dashboard. The cookie value is an opaque session token; no session data is stored in the cookie itself.
  • RealtimeKey — The Realtime app key. Together with X-Realtime-Secret, it authenticates a request to the Realtime API in addition to the workspace credential. Both values come…
  • RealtimeSecret — The Realtime app secret paired with X-Realtime-Key. The API returns the secret only when the key is created and does not store it. Create a new key and revoke…

Paths & Operations 16

Across 11 paths, the API surfaces 16 operations — 2 DELETE, 10 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

email-threads 16

Conversations in a mailbox. Threads group related inbound and outbound messages and carry read state, labels, and participants.

GET
/v1/email/threads
List threads
listEmailThreads 11 params → 200401403422429500
GET
/v1/email/threads/{thread_id}
Get a thread
getEmailThread 1 param → 200401403404410422429500
PATCH
/v1/email/threads/{thread_id}
Update a thread
updateEmailThread 2 params body → 200400401403404410422429
DELETE
/v1/email/threads/{thread_id}
Delete a thread
deleteEmailThread 3 params → 204401403404410422429500
GET
/v1/email/threads/{thread_id}/messages
List messages in a thread
listEmailThreadMessages 7 params → 200401403404410422429500
GET
/v1/email/threads/{thread_id}/messages/{message_id}
Get a message in a thread
getEmailThreadMessage 2 params → 200401403404410422429500
PATCH
/v1/email/threads/{thread_id}/messages/{message_id}
Update a message in a thread
updateEmailThreadMessage 3 params body → 200400401403404410422429
DELETE
/v1/email/threads/{thread_id}/messages/{message_id}
Delete a message in a thread
deleteEmailThreadMessage 4 params → 204401403404410422429500
GET
/v1/email/threads/{thread_id}/messages/{message_id}/body
Get a thread message's original body
getEmailThreadMessageBody 2 params → 200401403404410422429500
GET
/v1/email/threads/{thread_id}/messages/{message_id}/raw
Get a thread message's raw content
getEmailThreadMessageRaw 2 params → 200401403404410422429500
GET
/v1/email/threads/{thread_id}/messages/{message_id}/attachments
List a thread message's attachments
listEmailThreadMessageAttachments 2 params → 200401403404410422429500
GET
/v1/email/threads/{thread_id}/messages/{message_id}/attachments/{attachment_id}
Get a thread message's attachment
getEmailThreadMessageAttachment 3 params → 200401403404410422429500
POST
/v1/email/threads/{thread_id}/messages/{message_id}/reply
Reply to a thread message
replyEmailThreadMessage 3 params body → 202400401402403404409410
GET
/v1/email/mailboxes/{mailbox_id}/messages
List a mailbox's messages
listMailboxMessages 10 params → 200401403404422429500
POST
/v1/email/mailboxes/{mailbox_id}/messages
Create a message from a mailbox
createMailboxMessage 2 params body → 202400401402403404409422
GET
/v1/email/mailboxes/{mailbox_id}/labels
List a mailbox's labels
listMailboxLabels 1 param → 200401403404422429500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are EmailThreadMessage (25 properties), EmailThread (14 properties), ErrorBody (11 properties), EmailMailboxComposeRequest (11 properties). Each schema is shown below with its type and property counts.

_ListEnvelope
object
3 properties 3 required
EmailThreadMessageSource
object
Link to the message's entry in the received-message or sent-message log, which has delivery analytics such as per-recipient events. Log entries expire 30 days…
2 properties 2 required
EmailLabelsUpdate
object
Label changes to apply. Labels in add are applied and labels in remove are taken off; other labels are left untouched. Adding a label that is already present,…
2 properties
ErrorDetail
object
2 properties 2 required
ContactID
string
ErrorBody
object
11 properties 6 required
EmailThreadMessageReplyRequest
object
A reply to a conversation message. Recipients are derived from the message being replied to: its Reply-To address when present, otherwise its From address. Set…
7 properties
EmailThreadMessageList
EmailMailboxLabelList
object
The labels available in a mailbox.
1 property 1 required
EmailThreadMessageAttachmentList
object
The attachments on a conversation message.
1 property 1 required
EmailMailboxComposeRequest
object
A new message sent from a mailbox, starting a new conversation. Mirrors the plain send request without from, because the mailbox is who the message comes from,…
11 properties 2 required
EmailMailboxLabel
object
One label available in a mailbox.
2 properties 2 required
NextAction
object
5 properties 2 required
EmailMessageCategory
string
Content classification, which controls suppression policy: - marketing: Blocks on all suppression reasons. - transactional: Allows delivery through complaint a…
ThreadID
string
EmailThreadMessage
object
A message in a mailbox conversation, either direction. Message metadata, extracted text, and attachment bytes stay readable for the mailbox's retention tier. T…
25 properties 24 required
EmailThreadUpdateRequest
object
Changes to apply to a thread. Omitted fields are left unchanged.
2 properties
EmailAddressInput
A sender or recipient address. Accepts a plain email string (jane@acme.com), an RFC 5322 mailbox string with an embedded display name (Jane Doe ), or an object…
EmailThreadHighlights
object
Matched search fragments for a thread, one array per field the query matched, with the matched terms wrapped in . A field is present only when the query matche…
2 properties
EmailAddress
object
An email address with an optional display name.
2 properties 1 required
EmailThreadMessageUpdateRequest
object
Changes to apply to a conversation message. Omitted fields are left unchanged.
2 properties
MessageDirection
string
Whether a message was sent from the workspace (outbound) or received by it (inbound).
EmailThreadList
Error
object
1 property 1 required
EmailThread
object
A conversation in a mailbox. It groups every message in both directions, the mail the mailbox received and the replies it sent, and it holds the conversation's…
14 properties 13 required
Tag
object
Structured key/value label attached to a message or a call. Use tags for low-cardinality filtering dimensions (category, experiment ID, template ID); they surf…
2 properties 2 required
MailboxID
string
EmailThreadMessageRecipient
object
One recipient's terminal delivery outcome on a sent conversation message, recorded once the outcome becomes known.
2 properties 2 required
EmailThreadMessageBody
object
The original rendered body of a conversation message. Available for 30 days after the message occurred. After that, the endpoint returns 410 Gone, but the mess…
2 properties 2 required
EmailThreadMessageAttachment
object
Attachment metadata on a conversation message. Both the metadata and the attachment bytes stay available for the mailbox's retention tier.
4 properties 4 required
EmailAttachment
object
A file attached to an email. Put the base64-encoded bytes in content and the recipient-facing name in filename. To show an image inline, set contentid and refe…
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-email-threads-api-openapi.yml Raw ↑

Other APIs Bird publishes across the network.

Bird Customer Data API
Bird Phone Numbers API
Bird Identity Verification API
Bird Touchpoints API
Bird Accounts API
Bird FAQ API
Bird Intent API
Bird SMS Messaging API
Bird Channels API
Bird Contacts API
Bird Conversations API
Bird Legacy MessageBird API
Where this information came from

This is an independent, third-party profile of Bird Email Threads API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.