---
title: "Read tenant email sender settings"
description: "Returns provider configuration metadata and sender preferences. Credentials are write-only; only a safe configuration summary is returned.\n\n### Quire permissions\n\nRequired capability: `email/configure`.\n\nCredential scopes: `tenants:read`.\n\nThe acting subject must also be allowed to perform this action in the organisation."
image: "https://docs.quirelms.com/og.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.quirelms.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Quire API › tenants

`GET /tenant_email_settings`

Returns provider configuration metadata and sender preferences. Credentials are write-only; only a safe configuration summary is returned.

\### Quire permissions

Required capability: `email/configure`.

Credential scopes: `tenants:read`.

The acting subject must also be allowed to perform this action in the organisation.

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`, scopes: `tenants:read`
- `oauth2`, oauth2, scopes: `tenants:read`

## Header parameters

- `getTenantEmailSettings.header.Quire-Version` (string, optional) — The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied.
  - format `date`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://your-organisation.quirelms.com/api/v1/tenant_email_settings \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://your-organisation.quirelms.com/api/v1/tenant_email_settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://your-organisation.quirelms.com/api/v1/tenant_email_settings"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Success.

#### Example

```json
{
  "provider": "platform",
  "credentials_summary": "string",
  "from_name": "string",
  "reply_to": "string",
  "brand_color": "string",
  "logo_url": "string",
  "postal_address": "string",
  "track_opens": true,
  "track_clicks": true,
  "inbound_enabled": true,
  "inbound_auth_policy": "dmarc",
  "defaulted": true,
  "updated_at": "2019-08-24T14:15:22Z",
  "webhook_url": "string",
  "tracking_may_default_on": true,
  "platform_provider": "string",
  "providers": [
    {
      "id": "platform",
      "fields": [
        {
          "name": "string",
          "label": "string",
          "kind": "text",
          "secret": true,
          "required": true,
          "help": "string",
          "options": [
            "string"
          ]
        }
      ]
    }
  ]
}
```

- `getTenantEmailSettings.response.200.provider` (string, required)
  - one of `"platform"`, `"smtp"`, `"ses"`, `"resend"`, `"postmark"`, `"sendgrid"`, `"mailgun"`, `"cloudflare"`
- `getTenantEmailSettings.response.200.credentials_summary` (string | null, required)
- `getTenantEmailSettings.response.200.from_name` (string, required)
- `getTenantEmailSettings.response.200.reply_to` (string, required)
- `getTenantEmailSettings.response.200.brand_color` (string, required)
- `getTenantEmailSettings.response.200.logo_url` (string, required)
- `getTenantEmailSettings.response.200.postal_address` (string, required)
- `getTenantEmailSettings.response.200.track_opens` (boolean, required)
- `getTenantEmailSettings.response.200.track_clicks` (boolean, required)
- `getTenantEmailSettings.response.200.inbound_enabled` (boolean, required)
- `getTenantEmailSettings.response.200.inbound_auth_policy` (string, required)
  - one of `"dmarc"`, `"aligned_dkim_or_spf"`
- `getTenantEmailSettings.response.200.defaulted` (boolean, required)
- `getTenantEmailSettings.response.200.updated_at` (any of, required)
  - any of: `string`, `null`
- `getTenantEmailSettings.response.200.webhook_url` (string | null, required)
- `getTenantEmailSettings.response.200.tracking_may_default_on` (boolean, required)
- `getTenantEmailSettings.response.200.platform_provider` (string, required)
- `getTenantEmailSettings.response.200.providers` (array<object>, required)
  - `getTenantEmailSettings.response.200.providers.id` (string, required)
    - one of `"platform"`, `"smtp"`, `"ses"`, `"resend"`, `"postmark"`, `"sendgrid"`, `"mailgun"`, `"cloudflare"`
  - `getTenantEmailSettings.response.200.providers.fields` (array<object>, required)
    - `getTenantEmailSettings.response.200.providers.fields.name` (string, required)
    - `getTenantEmailSettings.response.200.providers.fields.label` (string, required)
    - `getTenantEmailSettings.response.200.providers.fields.kind` (string, required)
      - one of `"text"`, `"number"`, `"boolean"`, `"list"`, `"select"`
    - `getTenantEmailSettings.response.200.providers.fields.secret` (boolean, required)
    - `getTenantEmailSettings.response.200.providers.fields.required` (boolean, required)
    - `getTenantEmailSettings.response.200.providers.fields.help` (string, required)
    - `getTenantEmailSettings.response.200.providers.fields.options` (any of, required)
      - any of: `array<string>`, `null`

### 401

The credential is missing, malformed, expired or revoked.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getTenantEmailSettings.response.401.type` (string, required)
  - format `uri`
- `getTenantEmailSettings.response.401.title` (string, required)
- `getTenantEmailSettings.response.401.status` (integer, required)
- `getTenantEmailSettings.response.401.code` (string, required)
- `getTenantEmailSettings.response.401.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getTenantEmailSettings.response.401.detail` (string, required)
- `getTenantEmailSettings.response.401.request_id` (string, required)
- `getTenantEmailSettings.response.401.docs_url` (string, required)
  - format `uri`
- `getTenantEmailSettings.response.401.errors` (array<object>, optional)
  - `getTenantEmailSettings.response.401.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getTenantEmailSettings.response.401.errors.code` (string, required)
  - `getTenantEmailSettings.response.401.errors.detail` (string, required)
- `getTenantEmailSettings.response.401.retry_after` (integer | null, optional)

### 403

The credential lacks the scope this operation requires, or the acting subject lacks the capability.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getTenantEmailSettings.response.403.type` (string, required)
  - format `uri`
- `getTenantEmailSettings.response.403.title` (string, required)
- `getTenantEmailSettings.response.403.status` (integer, required)
- `getTenantEmailSettings.response.403.code` (string, required)
- `getTenantEmailSettings.response.403.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getTenantEmailSettings.response.403.detail` (string, required)
- `getTenantEmailSettings.response.403.request_id` (string, required)
- `getTenantEmailSettings.response.403.docs_url` (string, required)
  - format `uri`
- `getTenantEmailSettings.response.403.errors` (array<object>, optional)
  - `getTenantEmailSettings.response.403.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getTenantEmailSettings.response.403.errors.code` (string, required)
  - `getTenantEmailSettings.response.403.errors.detail` (string, required)
- `getTenantEmailSettings.response.403.retry_after` (integer | null, optional)

### 422

The request was understood and its content is not valid. `errors` names each field.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getTenantEmailSettings.response.422.type` (string, required)
  - format `uri`
- `getTenantEmailSettings.response.422.title` (string, required)
- `getTenantEmailSettings.response.422.status` (integer, required)
- `getTenantEmailSettings.response.422.code` (string, required)
- `getTenantEmailSettings.response.422.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getTenantEmailSettings.response.422.detail` (string, required)
- `getTenantEmailSettings.response.422.request_id` (string, required)
- `getTenantEmailSettings.response.422.docs_url` (string, required)
  - format `uri`
- `getTenantEmailSettings.response.422.errors` (array<object>, optional)
  - `getTenantEmailSettings.response.422.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getTenantEmailSettings.response.422.errors.code` (string, required)
  - `getTenantEmailSettings.response.422.errors.detail` (string, required)
- `getTenantEmailSettings.response.422.retry_after` (integer | null, optional)

### 429

A rate limit or a concurrency cap was reached. `Retry-After` says when to try again.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getTenantEmailSettings.response.429.type` (string, required)
  - format `uri`
- `getTenantEmailSettings.response.429.title` (string, required)
- `getTenantEmailSettings.response.429.status` (integer, required)
- `getTenantEmailSettings.response.429.code` (string, required)
- `getTenantEmailSettings.response.429.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getTenantEmailSettings.response.429.detail` (string, required)
- `getTenantEmailSettings.response.429.request_id` (string, required)
- `getTenantEmailSettings.response.429.docs_url` (string, required)
  - format `uri`
- `getTenantEmailSettings.response.429.errors` (array<object>, optional)
  - `getTenantEmailSettings.response.429.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getTenantEmailSettings.response.429.errors.code` (string, required)
  - `getTenantEmailSettings.response.429.errors.detail` (string, required)
- `getTenantEmailSettings.response.429.retry_after` (integer | null, optional)

### 500

Something failed at our end. Quote `request_id` when reporting it.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "code": "string",
  "category": "validation",
  "detail": "string",
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "detail": "string"
    }
  ],
  "retry_after": 0,
  "docs_url": "http://example.com"
}
```

- `getTenantEmailSettings.response.500.type` (string, required)
  - format `uri`
- `getTenantEmailSettings.response.500.title` (string, required)
- `getTenantEmailSettings.response.500.status` (integer, required)
- `getTenantEmailSettings.response.500.code` (string, required)
- `getTenantEmailSettings.response.500.category` (string, required)
  - one of `"validation"`, `"authentication"`, `"authorization"`, `"not_found"`, `"conflict"`, `"precondition"`, `"quota"`, `"rate_limit"`, `"upstream"`, `"internal"`
- `getTenantEmailSettings.response.500.detail` (string, required)
- `getTenantEmailSettings.response.500.request_id` (string, required)
- `getTenantEmailSettings.response.500.docs_url` (string, required)
  - format `uri`
- `getTenantEmailSettings.response.500.errors` (array<object>, optional)
  - `getTenantEmailSettings.response.500.errors.path` (string, required) — RFC 6901 JSON Pointer into the request body.
  - `getTenantEmailSettings.response.500.errors.code` (string, required)
  - `getTenantEmailSettings.response.500.errors.detail` (string, required)
- `getTenantEmailSettings.response.500.retry_after` (integer | null, optional)


Source: https://docs.quirelms.com/api/tenants/getTenantEmailSettings/index.md