emailConfig

Requires permission settings:email:read.

Returns the organization's email sending configuration, or null when none exists. Requires permission to read email settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query EmailConfig {
  emailConfig {
    id
    fromName
    createdAt
    createdBy
    dailyReportTime
    defaultRecipients
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query EmailConfig {\n  emailConfig {\n    id\n    fromName\n    createdAt\n    createdBy\n    dailyReportTime\n    defaultRecipients\n  }\n}"
}
EOF

Response:

{
  "data": {
    "emailConfig": {
      "id": "string",
      "fromName": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "createdBy": "string",
      "dailyReportTime": "string",
      "defaultRecipients": [
        "string"
      ]
    }
  }
}

emailConfig: EmailConfig

Type

EmailConfig object

The organization's email settings. Secrets are never returned.