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 Inbound Messages API

Emails received on your behalf, including each parsed message, its body, raw MIME content, and attachments.

Bird Email Inbound Messages 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-inbound-messages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 6 operations across 6 paths, and defines 14 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.

6 operations 6 paths 14 schemas 6 GET

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 Inbound Messages 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 6

Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.

email-inbound-messages 6

Emails received on your behalf, including each parsed message, its body, raw MIME content, and attachments.

GET
/v1/email/inbound-messages
List received emails
listInboundMessages 7 params → 200401403422429500
GET
/v1/email/inbound-messages/{inbound_message_id}
Get a received email
getInboundMessage 1 param → 200401403404422429500
GET
/v1/email/inbound-messages/{inbound_message_id}/body
Get a received email's body
getInboundMessageBody 1 param → 200401403404422429500
GET
/v1/email/inbound-messages/{inbound_message_id}/raw
Get a received email's raw content
getInboundMessageRaw 1 param → 200401403404422429500
GET
/v1/email/inbound-messages/{inbound_message_id}/attachments
List a received email's attachments
listInboundMessageAttachments 1 param → 200401403404422429500
GET
/v1/email/inbound-messages/{inbound_message_id}/attachments/{attachment_id}
Get a received email's attachment
getInboundMessageAttachment 2 params → 200401403404422429500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are InboundEmailMessage (16 properties), ErrorBody (11 properties), NextAction (5 properties), InboundAttachment (4 properties). Each schema is shown below with its type and property counts.

InboundAttachmentList
object
The attachments on a received email. The response returns every attachment without pagination.
1 property 1 required
_ListEnvelope
object
3 properties 3 required
ErrorDetail
object
2 properties 2 required
ErrorBody
object
11 properties 6 required
NextAction
object
5 properties 2 required
InboundEmailMessage
object
An email received on your behalf, parsed from the original message. Fetch the body with /body, the original MIME with /raw, and attachment bytes with /attachme…
16 properties 15 required
InboundEmailMessageID
string
InboundAttachmentID
string
InboundEmailMessageList
InboundAddressID
string
EmailAddress
object
An email address with an optional display name.
2 properties 1 required
Error
object
1 property 1 required
InboundAttachment
object
Metadata for a file attached to a received email. The raw bytes are fetched separately with GET /v1/email/inbound-messages/{inboundmessageid}/attachments/{atta…
4 properties 4 required
InboundEmailMessageBody
object
The parsed body of a received email.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-email-inbound-messages-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 Inbound Messages 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.