Deployments.ai Docs
Email

List a tenant's sending domains

GET /v1/email/tenants/{tenantId}/domains · SDK listEmailDomains · CLI deployments email-domain list

GET
/v1/email/tenants/{tenantId}/domains

Requires email:read.

Authorization

platformBearer
headerAuthorizationBearer <token>

Platform bearer credential accepted as an opaque API key or JWT.

Path Parameters

tenantId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Query Parameters

cursor?string
Length1 <= length <= 4096
limit?integer
Range1 <= value <= 100

Header Parameters

x-deployments-environment*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

EmailDomainPageResponse

application/json
  1. response
items*array<>
nextCursor?|null
curl -X GET "https://example.com/v1/email/tenants/string/domains" \  -H "x-deployments-environment: string"
{  "items": [    {      "id": "string",      "organizationId": "string",      "projectId": "string",      "environmentId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "tenantId": "string",      "domain": "string",      "status": "pending",      "dnsRecords": [        {          "name": "string",          "type": "CNAME",          "value": "string",          "priority": 0        }      ],      "mailFromDomain": "string",      "failureReason": "string",      "lastCheckedAt": "2019-08-24T14:15:22Z",      "verifiedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": "string"}