v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Emails::Settings

Get Email Settings

Retrieve email settings for a workspace

get/workspaces/{workspace_id}/emails/settings

Path parameters

workspace_idinteger required

Response

OK

workspace_idinteger

Workspace ID

address_completeboolean

True once the marketing address satisfies the email broadcast gate

Example response

{
  "workspace_id": 42000,
  "system_emails_from_address": {
    "email_address": "system@example.com",
    "name": "System Notifications"
  },
  "system_emails_reply_to_address": {
    "email_address": "support@example.com",
    "name": "Support"
  },
  "marketing_emails_from_address": {
    "email_address": "marketing@example.com",
    "name": "Marketing Team"
  },
  "marketing_emails_reply_to_address": null,
  "address": {
    "address_one": "123 Main St",
    "address_two": null,
    "city": "San Francisco",
    "postal_code": "94105",
    "region_name": "California",
    "region": "CA",
    "country": "US"
  },
  "address_complete": true
}