List agent domains
GET
/v1/email/agent-domains
curl -X GET "https://us1.platform.bird.com/v1/email/agent-domains" \
-H "Authorization: Bearer $TOKEN"Returns the workspace's agent domains. A workspace holds at most one active agent domain; released domains stay listed because their handles remain reserved to this workspace.
Response Payload
data
array of object
आवश्यक
चाइल्ड एट्रिब्यूट दिखाएँ
data.id
string
आवश्यक
Agent domain ID.
data.handle
string
आवश्यक
The claimed handle — the leftmost label of the agent domain. Immutable.
data.domain
string
आवश्यक
The full agent domain that mailbox addresses live under.
data.status
string
आवश्यक
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.
data.released_at
nullable string
When the domain was released. Null while active.
data.created_at
string
आवश्यक
When the domain was claimed.
data.updated_at
string
आवश्यक
When the domain was last updated.