List inbound addresses
GET
/v1/email/inbound-addresses
curl -X GET "https://us1.platform.bird.com/v1/email/inbound-addresses" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"Returns a paginated list of the workspace's inbound addresses — the Bird-minted addresses you forward real mailboxes to.
Paramètres de requête
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
Contenu de la réponse
data
array of object
obligatoire
Afficher les attributs enfants
data.id
string
obligatoire
Inbound address ID.
data.address
string
obligatoire
The address to forward your mailbox to. Minted by Bird when the inbound address is created.
data.label
nullable string
obligatoire
Your own label for this address, typically the source mailbox it maps to. Null when unset.
data.created_at
string
obligatoire
When the inbound address was created.
data.updated_at
string
obligatoire
When the inbound address was last updated.
next_cursor
nullable string
obligatoire
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
obligatoire
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
obligatoire
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.