<Intro>

<EndpointHeader />

<Description>

Returns a paginated list of the workspace's inbound addresses — the Bird-minted addresses you forward real mailboxes to.

</Description>

</Intro>

<Parameters in="query">

<Parameter name="limit" type="integer">

<Description>

Maximum number of items to return per page.

</Description>

</Parameter>

<Parameter name="starting_after" type="string">

<Description>

Cursor from the `next_cursor` field of a previous list response. Returns items immediately after the cursor position in the current sort order.

</Description>

</Parameter>

<Parameter name="ending_before" type="string">

<Description>

Cursor from the `prev_cursor` field of a previous list response. Returns items immediately before the cursor position in the current sort order.

</Description>

</Parameter>

</Parameters>

<Payload kind="response">

<Field name="data" type="array of object" required>

<Description>

Page of inbound addresses, newest first.

</Description>

<FieldChildren kind="response">

<Field name="id" type="string" prefix="data." required>

<Description>

Inbound address ID.

</Description>

</Field>

<Field name="address" type="string" prefix="data." required>

<Description>

The address to forward your mailbox to. Minted by Bird when the inbound address is created.

</Description>

</Field>

<Field name="label" type="nullable string" prefix="data." required>

<Description>

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

</Description>

</Field>

<Field name="created_at" type="string" prefix="data." required>

<Description>

When the inbound address was created.

</Description>

</Field>

<Field name="updated_at" type="string" prefix="data." required>

<Description>

When the inbound address was last updated.

</Description>

</Field>

</FieldChildren>

</Field>

<Field name="next_cursor" type="nullable string" required>

<Description>

Cursor for the next page. Pass back as `starting_after` to advance forward. Null when no next page exists.

</Description>

</Field>

<Field name="prev_cursor" type="nullable string" required>

<Description>

Cursor for the previous page. Pass back as `ending_before` to step backward. Null when no previous page exists.

</Description>

</Field>

<Field name="refresh_cursor" type="nullable string" required>

<Description>

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`.

</Description>

</Field>

</Payload>