Documentation
Sign inGet started

Get an agent domain

GET
/v1/email/agent-domains/{agent_domain_id}
curl -X GET "https://us1.platform.bird.com/v1/email/agent-domains/{agent_domain_id}" \
  -H "Authorization: Bearer $TOKEN"
Returns a single agent domain by ID.
Payload Respons
id
string
wajib
Agent domain ID.
handle
string
wajib
The claimed handle — the leftmost label of the agent domain. Immutable.
domain
string
wajib
The full agent domain that mailbox addresses live under.
status
string
wajib
Lifecycle status. provisioning domains are being set up and become active shortly — poll the domain until it does. active domains receive mail. releasing domains are being released; once released they no longer receive mail, and the handle stays reserved to this workspace.
released_at
nullable string
When the domain was released. Null while active.
created_at
string
wajib
When the domain was claimed.
updated_at
string
wajib
When the domain was last updated.