Email · emailsGet

Get workspace email

Returns the automatic workspace address and readiness. A connected delegated domain is used when available; otherwise the platform address is used. DNS setup is automatic. The stable resource ID is used in Business Action permission declarations.

GET/v1/emails

betaauthenticatedworkspace

When to use

Get the automatic workspace address, readiness and email permission resource ID.

For agents

Requires Read on workspace email. An email-ready connected delegated domain supplies the address; otherwise the platform fallback is used. DNS is automatic. The stable resource ID delegates the workspace email capability, including future automatic address changes. Wait for ready before sending. No mailbox is created.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);

const result = await client.emails.get();

Response

json

{
  "data": {
    "id": "esnd_abcdefghijklmnopqrstuvwx",
    "address": "noreply@example.com",
    "status": "ready",
    "error": null
  }
}