email-inbound-messages

List a received email's attachments

Returns metadata for each attachment on a received email:

  • The attachment_id.
  • The declared filename.
  • The MIME type.
  • The size.

The same manifest is embedded in Get a received email. Fetch an individual attachment's bytes with Get a received email's attachment.

get/v1/email/inbound-messages/{inbound_message_id}/attachments

Request

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

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

The attachments on the received email.

Example response

{
  "data": [
    {
      "id": "rea_01krdgeqcxet5s7t44vh8rt9mg",
      "filename": "invoice.pdf",
      "content_type": "application/pdf",
      "size": 215432
    }
  ]
}

Changes

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