tenantEmailSettings

Requires at least one of the permissions settings:email:read or settings:tenant:read.

Returns the organization's quote email settings: the reply address, the sender name suffix and whether quotes may be emailed, or null when none were saved. Requires permission to read email or tenant 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 TenantEmailSettings {
  tenantEmailSettings {
    id
    createdAt
    avgResponseTimeHours
    fromNameSuffix
    lastEmailSentAt
    organizationId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query TenantEmailSettings {\n  tenantEmailSettings {\n    id\n    createdAt\n    avgResponseTimeHours\n    fromNameSuffix\n    lastEmailSentAt\n    organizationId\n  }\n}"
}
EOF

Response:

{
  "data": {
    "tenantEmailSettings": {
      "id": "id",
      "createdAt": "2025-01-15T00:00:00Z",
      "avgResponseTimeHours": 0,
      "fromNameSuffix": "string",
      "lastEmailSentAt": "2025-01-15T00:00:00Z",
      "organizationId": "string"
    }
  }
}

tenantEmailSettings: TenantEmailSettings

Type

TenantEmailSettings object

Your organization's document email settings and lifetime totals.