List a receiving domain's per-entity addresses

Search Documentation

Search across all developer documentation

inbound

List a receiving domain's per-entity addresses

GET /v1/inbound/domains/{domain}/addresses
Auth required api.inbound.view

The LIVE addresses minted at this receiving domain, oldest first. A revoked address is not returned: it delivers no metadata, so listing it beside live ones would invite a client to treat the two alike.

This is not the list of addresses that can receive mail. The receipt rule SendOps deploys is a catch-all, so unless the domain's allow_patterns is non-empty every recipient at the domain is delivered whether or not it appears here.

Path parameters

domain string required

The receiving domain, by NAME (in.acme.com). A UUID is also accepted. Matched case-insensitively, and scoped to the calling org — a domain belonging to another org is a 404, never a 403.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 The domain's live per-entity addresses application/json
data array<object> required

Each entry in data:

id string<uuid> required
local_part string required

The part before the "@". Pass this back to revoke.

address string required

local_part@domain — the mailbox a sender writes to. Carried alongside local_part deliberately: a client that has to concatenate the two has a way to get it wrong.

metadata object required

The JSON returned in the entities map of every webhook payload delivered to this address. Always an object; {} when none was given.

created_at string<date-time> required
pagination object required

Fields of pagination:

has_more boolean required
next_cursor string | null optional
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json