Documentation
Sign inGet started

Get an inbound address

GET
/v1/email/inbound-addresses/{inbound_address_id}
curl -X GET "https://us1.platform.bird.com/v1/email/inbound-addresses/{inbound_address_id}" \
  -H "Authorization: Bearer $TOKEN"
Returns a single inbound address: the Bird-minted 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.
Response Payload
id
string
required
Inbound address ID.
address
string
required
The address to forward your mailbox to. Minted by Bird when the inbound address is created.
label
nullable string
required
Your own label for this address, typically the source mailbox it maps to. Null when unset.
created_at
string
required
When the inbound address was created.
updated_at
string
required
When the inbound address was last updated.