---
title: "GET /v1/email/sender-settings"
method: GET
path: "/v1/email/sender-settings"
tags: ["Communications"]
---

# GET /v1/email/sender-settings

`GET /v1/email/sender-settings`

## Request

- Base URL: `https://api.yardstick.team`
- URL: `https://api.yardstick.team/v1/email/sender-settings`
- Auth: HTTP bearer

GET /v1/email/sender-settings

**Required scopes:** `communications:read`

## Headers

- `X-Request-Id` string

## Response `200`

Success

- EmailSenderSettings
  - `object` 'email_sender_settings', required
  - `livemode` boolean, required
  - `connections` object[], required
    - `object` 'email_sender_connection', required
    - `provider_connection_id` string, required
    - `user_id` string, nullable, required
    - `provider` string, required
    - `status` string, required
    - `provider_account_email` string, nullable, required
    - `provider_account_name` string, nullable, required
    - `scopes_granted` string[], required
    - `expires_at` string, nullable, required
    - `last_refresh_at` string, nullable, required
    - `last_error_code` string, nullable, required
    - `sender_identity_sync_status` string, required
    - `sender_identity_sync_error_code` string, nullable, required
    - `sender_identity_sync_last_attempted_at` string, nullable, required
    - `sender_identity_sync_last_synced_at` string, nullable, required
    - `identity_count` integer, required
    - `available_identity_count` integer, required
    - `created_at` string, nullable, required
    - `updated_at` string, nullable, required
  - `identities` object[], required
    - `object` 'email_sender_identity', required
    - `id` string, required
    - `user_id` string, nullable, required
    - `provider_connection_id` string, required
    - `provider` string, required
    - `identity_type` string, required
    - `email` string, required
    - `display_name` string, nullable, required
    - `status` string, required
    - `validation_error_code` string, nullable, required
    - `validated_at` string, nullable, required
    - `unavailable_at` string, nullable, required
    - `created_at` string, nullable, required
    - `updated_at` string, nullable, required
  - `defaults` object[], required
    - `object` 'email_sender_default', required
    - `id` string, nullable, required
    - `email_type` string, required
    - `default_sender_type` string, required
    - `org_shared_sender_identity_id` string, nullable, required
    - `org_shared_sender_email` string, nullable, required
    - `org_shared_sender_display_name` string, nullable, required
    - `created_at` string, nullable, required
    - `updated_at` string, nullable, required
  - `queue` object[], required
    - `object` 'email_sender_queue_item', required
    - `id` string, required
    - `email_draft_id` string, nullable, required
    - `application_id` string, nullable, required
    - `email_type` string, required
    - `queue_status` string, required
    - `sender_resolution_type` string, nullable, required
    - `requested_sender_identity_id` string, nullable, required
    - `resolved_sender_identity_id` string, nullable, required
    - `reason_code` string, nullable, required
    - `attempts_count` integer, required
    - `last_attempt_at` string, nullable, required
    - `last_error_code` string, nullable, required
    - `next_attempt_at` string, nullable, required
    - `latest_attempt_status` string, nullable, required
    - `latest_attempt_provider` string, nullable, required
    - `latest_attempt_error_code` string, nullable, required
    - `latest_attempt_at` string, nullable, required
    - `diagnostic_schema_version` integer, nullable, required
    - `failure_phase` 'default_missing' | 'job_resolution_failed' | 'identity_unavailable' | 'provider_connection_unavailable' | 'token_unavailable' | 'provider_send_failed' | 'system_fallback_disallowed' | 'system_fallback_failed', nullable, required
    - `selected_transport` 'google' | 'microsoft' | 'resend' | 'none', nullable, required
    - `fallback_eligible` boolean, nullable, required
    - `safe_next_action` 'configure_default_sender' | 'assign_job_sender' | 'review_sender_identity' | 'reconnect_provider' | 'configure_customer_sender' | 'configure_system_sender' | 'retry_after_provider_recovery', nullable, required
    - `created_at` string, nullable, required
    - `updated_at` string, nullable, required

## Other responses

- `400`: Invalid request
- `401`: Authentication failure
- `403`: Permission denied (scope or feature flag)
- `404`: Resource not found. The error uses the resource-specific code and param names the exact body field or path parameter that referenced it.
- `409`: Conflict (e.g. idempotency key reuse with different body)
- `429`: Rate limited
- `500`: Internal error

---

[API](https://skmtc.dev/yardstick/apis/yardstick-public-api.md) · [All operations](https://skmtc.dev/yardstick/apis/yardstick-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yardstick/apis/yardstick-public-api/revisions/35b5a6e88b35?raw)