email-inbound-addresses

Get an inbound address

Returns a single inbound address: the address you forward a mailbox to, and the label you gave it. Use List inbound addresses to find IDs. A deleted or unknown address returns 404.

get/v1/email/inbound-addresses/{inbound_address_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/inbound-addresses/{inbound_address_id}
  • 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

Inbound address object.

idstring required
addressstring email required

The address to forward your mailbox to. We generate it when the inbound address is created.

labelstring nullable required

Your own label for this address, typically the source mailbox it maps to. null when unset.

created_atstring date-time required

When the inbound address was created.

updated_atstring date-time required

When the inbound address was last updated.

Example response

{
  "id": "ina_01krdgeqcxet5s7t44vh8rt9mg",
  "address": "mfzxq2lom5uxi3lb@eu1.inbound.bird.com",
  "label": "Support mailbox"
}

Changes

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