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

# Search email account health

> List the health snapshots of the team's mailboxes: health_score (0 to 100), warmup_level, sent and bounce, complaint, reply and open rates of the last 30 days, the DNS state and tips (what to fix, worst first). Each row is one capture, so a mailbox has a history. Use it for which mailboxes are at risk (health_score lt 50, sort health_score asc) and how one mailbox moved over time (email_account_sid with a created_at range). For the latest snapshot of a mailbox use get_email_account or search_email_accounts with include health; for the bounces behind a rate, search_email_bounce_log. A snapshot is taken on a schedule and cannot be forced. Requires can_view_email_accounts.

Contract:
- MCP tool `search_email_account_health`, registry package `mcp.email/email_account_health`, mount `email.accounts`.
- Operation `search`, response envelope `search`.
- Flags: read only.



## OpenAPI

````yaml /api-reference/email/openapi.yaml post /api/email-account-health/search
openapi: 3.0.3
info:
  title: 'GTM API public contract: gtm.service.email'
  description: >-
    Connected mailboxes and everything driven through them: Google, Microsoft
    and IMAP/SMTP accounts with their limits, warmup and health, the mirrored
    inbox (threads, messages, folders), sending now or on a schedule (a repeat
    under the caller's own key is answered by the first send), the stop-list,
    bounces and engagement, the sign-in applications mailboxes connect through,
    and tracking and sending domains.


    GENERATED. This document is projected from the Zod MCP tool registry in
    `product/mcp/gtm.mcp` (one tool per public endpoint, 1:1). Do not edit it by
    hand; edit the tool definition and regenerate with `pnpm openapi:public`.


    Surface: the public `/api` contract of `gtm.service.email`, 65 operations.
    This is the only OpenAPI document the platform publishes. Internal
    (`/internal`) and health endpoints are deliberately absent: they are not
    part of any contract, they can change without notice, and the service source
    is their only description.


    Conventions:

    - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header.

    - Every success body is an MCP envelope: `success: true` plus one typed
    `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`,
    `group_by`, `action`), and a `meta` block with `trace_id` for support.

    - Every failure is the same `McpError` envelope with a code from a fixed
    16-code taxonomy, so a client maps errors once.

    - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward
    `cursor`; `page_size: 0` returns counts only.

    - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`)
    travel as JSON text and array-valued ones repeat as `name[]=value`.

    - The MCP-only `_meta` field (usage analytics) never reaches the backend and
    is not part of this contract.

    - A workspace may own several email servers, each with its own mailboxes and
    data, behind this one address. The `Email-Box-SID` header names the server a
    call is for (`em_bx_...`, listed by `POST /api/email-boxes/search` of
    gtm.service.id); without it the call goes to the workspace's primary server.
    A sid belongs to the server that answered it: on another server it is
    `not_found`. A workspace with no server serving yet answers 409 `conflict`,
    reason `email_box_not_ready`.
  version: '1.0'
  contact:
    name: GTM API
    url: https://gtm-api.com
    email: support@gtm-api.com
  license:
    name: Proprietary
    url: https://gtm-api.com/license
servers:
  - url: https://app.gtm-api.com/email/v4
    description: Production, through the app.gtm-api.com gateway
security:
  - BearerJwt: []
    TeamSid: []
tags:
  - name: email_account_activity_log
    description: >-
      Registry package `mcp.email/email_account_activity_log`, served on MCP
      mount `email.accounts`.
  - name: email_account_health
    description: >-
      Registry package `mcp.email/email_account_health`, served on MCP mount
      `email.accounts`.
  - name: email_account_sync_runs
    description: >-
      Registry package `mcp.email/email_account_sync_runs`, served on MCP mount
      `email.accounts`.
  - name: email_accounts
    description: >-
      Registry package `mcp.email/email_accounts`, served on MCP mount
      `email.accounts`.
  - name: email_bounce_log
    description: >-
      Registry package `mcp.email/email_bounce_log`, served on MCP mount
      `email.deliverability`.
  - name: email_box_settings
    description: >-
      Registry package `mcp.email/email_box_settings`, served on MCP mount
      `email.infrastructure`.
  - name: email_domains
    description: >-
      Registry package `mcp.email/email_domains`, served on MCP mount
      `email.infrastructure`.
  - name: email_engagements
    description: >-
      Registry package `mcp.email/email_engagements`, served on MCP mount
      `email.deliverability`.
  - name: email_folders
    description: >-
      Registry package `mcp.email/email_folders`, served on MCP mount
      `email.messaging`.
  - name: email_messages
    description: >-
      Registry package `mcp.email/email_messages`, served on MCP mount
      `email.messaging`.
  - name: email_oauth_apps
    description: >-
      Registry package `mcp.email/email_oauth_apps`, served on MCP mount
      `email.infrastructure`.
  - name: email_sending_domains
    description: >-
      Registry package `mcp.email/email_sending_domains`, served on MCP mount
      `email.infrastructure`.
  - name: email_suppressions
    description: >-
      Registry package `mcp.email/email_suppressions`, served on MCP mount
      `email.deliverability`.
  - name: email_threads
    description: >-
      Registry package `mcp.email/email_threads`, served on MCP mount
      `email.messaging`.
  - name: email_tracking_domains
    description: >-
      Registry package `mcp.email/email_tracking_domains`, served on MCP mount
      `email.infrastructure`.
paths:
  /api/email-account-health/search:
    post:
      tags:
        - email_account_health
      summary: Search email account health
      description: >-
        List the health snapshots of the team's mailboxes: health_score (0 to
        100), warmup_level, sent and bounce, complaint, reply and open rates of
        the last 30 days, the DNS state and tips (what to fix, worst first).
        Each row is one capture, so a mailbox has a history. Use it for which
        mailboxes are at risk (health_score lt 50, sort health_score asc) and
        how one mailbox moved over time (email_account_sid with a created_at
        range). For the latest snapshot of a mailbox use get_email_account or
        search_email_accounts with include health; for the bounces behind a
        rate, search_email_bounce_log. A snapshot is taken on a schedule and
        cannot be forced. Requires can_view_email_accounts.


        Contract:

        - MCP tool `search_email_account_health`, registry package
        `mcp.email/email_account_health`, mount `email.accounts`.

        - Operation `search`, response envelope `search`.

        - Flags: read only.
      operationId: search_email_account_health
      parameters:
        - $ref: '#/components/parameters/EmailBoxSid'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchEmailAccountHealthRequest'
      responses:
        '200':
          description: '`search` success envelope.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchEmailAccountHealthResponse'
        4XX:
          $ref: '#/components/responses/McpClientError'
        5XX:
          $ref: '#/components/responses/McpServerError'
components:
  parameters:
    EmailBoxSid:
      name: Email-Box-SID
      in: header
      required: false
      description: >-
        Email server (em_bx_...) the call is for, from search_email_boxes.
        Omitted: the primary server.
      schema:
        type: string
        pattern: ^em_bx_[A-Za-z0-9]{12}$
  schemas:
    SearchEmailAccountHealthRequest:
      type: object
      description: Request body of `search_email_account_health`.
      properties:
        filter:
          type: object
          properties:
            sid:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
              additionalProperties: false
            email_account_sid:
              type: object
              properties:
                eq:
                  type: string
                in:
                  type: array
                  items:
                    type: string
              additionalProperties: false
              description: One mailbox's history.
            health_score:
              type: object
              properties:
                eq:
                  type: integer
                  minimum: 0
                  maximum: 100
                ne:
                  type: integer
                  minimum: 0
                  maximum: 100
                gte:
                  type: integer
                  minimum: 0
                  maximum: 100
                lte:
                  type: integer
                  minimum: 0
                  maximum: 100
                gt:
                  type: integer
                  minimum: 0
                  maximum: 100
                lt:
                  type: integer
                  minimum: 0
                  maximum: 100
              additionalProperties: false
              description: '{ lt: 50 } is the at-risk band.'
            warmup_level:
              type: object
              properties:
                eq:
                  type: string
                  enum:
                    - cold
                    - warming
                    - warm
                ne:
                  type: string
                  enum:
                    - cold
                    - warming
                    - warm
                in:
                  type: array
                  items:
                    type: string
                    enum:
                      - cold
                      - warming
                      - warm
                nin:
                  type: array
                  items:
                    type: string
                    enum:
                      - cold
                      - warming
                      - warm
              additionalProperties: false
            bounce_rate_30d:
              type: object
              properties:
                gte:
                  type: number
                  minimum: 0
                  maximum: 1
                lte:
                  type: number
                  minimum: 0
                  maximum: 1
                gt:
                  type: number
                  minimum: 0
                  maximum: 1
                lt:
                  type: number
                  minimum: 0
                  maximum: 1
                is_null:
                  type: boolean
              additionalProperties: false
              description: '0 to 1. { is_null: true }: nothing sent in the 30 days.'
            created_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                gt:
                  type: string
                lt:
                  type: string
              additionalProperties: false
              description: When the snapshot was taken.
            deleted_at:
              type: object
              properties:
                gte:
                  type: string
                lte:
                  type: string
                is_null:
                  type: boolean
              additionalProperties: false
        sort:
          type: object
          properties:
            field:
              type: string
              enum:
                - created_at
                - health_score
            direction:
              type: string
              enum:
                - asc
                - desc
              description: Default desc.
          required:
            - field
        page_size:
          type: integer
          minimum: 0
          maximum: 500
          description: >-
            0..500, default 50. page_size=0 = count-only, page_size=1 =
            getFirst.
        cursor:
          type: string
          nullable: true
          description: >-
            Opaque forward cursor from a previous response
            pagination.next_cursor.
    SearchEmailAccountHealthResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        operation:
          type: string
          enum:
            - search
        items:
          type: array
          items:
            type: object
            properties:
              item:
                type: object
                properties:
                  sid:
                    type: string
                  team_sid:
                    type: string
                  email_account_sid:
                    type: string
                  health_score:
                    type: integer
                    description: 0 to 100.
                  warmup_level:
                    type: string
                    enum:
                      - cold
                      - warming
                      - warm
                  sent_7d:
                    type: integer
                  sent_30d:
                    type: integer
                  bounce_rate_30d:
                    type: number
                    nullable: true
                    description: 0 to 1; null when nothing was sent in the window.
                  hard_bounces_30d:
                    type: integer
                  soft_bounces_30d:
                    type: integer
                  policy_blocks_30d:
                    type: integer
                  complaints_30d:
                    type: integer
                  complaint_rate_30d:
                    type: number
                    nullable: true
                  reply_rate_30d:
                    type: number
                    nullable: true
                  tracked_open_rate_30d:
                    type: number
                    nullable: true
                    description: Opens over the sends that carried open tracking.
                  reconnect_incidents_30d:
                    type: integer
                  warmup_enabled:
                    type: boolean
                  dns_health:
                    type: object
                    nullable: true
                    properties:
                      mx:
                        type: string
                        enum:
                          - valid
                          - pending
                          - invalid
                          - na
                      spf:
                        type: string
                        enum:
                          - valid
                          - pending
                          - invalid
                          - na
                      dkim:
                        type: string
                        enum:
                          - valid
                          - pending
                          - invalid
                          - na
                      dmarc:
                        type: string
                        enum:
                          - valid
                          - pending
                          - invalid
                          - na
                      return_path:
                        type: string
                        enum:
                          - valid
                          - pending
                          - invalid
                          - na
                      tracking_domain:
                        type: string
                        enum:
                          - valid
                          - pending
                          - invalid
                          - na
                    required:
                      - mx
                      - spf
                      - dkim
                      - dmarc
                      - return_path
                      - tracking_domain
                  sending_paused_reason:
                    type: string
                    nullable: true
                    enum:
                      - manual
                      - bounce_rate
                      - complaint_rate
                      - provider_block
                      - warmup_guard
                      - provider_quota
                  tips:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        severity:
                          type: string
                        message:
                          type: string
                      required:
                        - code
                        - severity
                        - message
                    description: What to fix, worst first; empty when healthy.
                  created_at:
                    type: string
                    nullable: true
                    description: When the snapshot was taken.
                  updated_at:
                    type: string
                    nullable: true
                  deleted_at:
                    type: string
                    nullable: true
                required:
                  - sid
                  - team_sid
                  - email_account_sid
                  - health_score
                  - warmup_level
                  - sent_7d
                  - sent_30d
                  - bounce_rate_30d
                  - hard_bounces_30d
                  - soft_bounces_30d
                  - policy_blocks_30d
                  - complaints_30d
                  - complaint_rate_30d
                  - reply_rate_30d
                  - tracked_open_rate_30d
                  - reconnect_incidents_30d
                  - warmup_enabled
                  - dns_health
                  - sending_paused_reason
                  - tips
                  - created_at
                  - updated_at
                  - deleted_at
              included:
                type: object
                additionalProperties: {}
            required:
              - item
              - included
        pagination:
          type: object
          properties:
            next_cursor:
              type: string
              nullable: true
            has_more:
              type: boolean
            total_count:
              type: integer
              nullable: true
          required:
            - next_cursor
            - has_more
            - total_count
        applied_filters:
          type: object
          additionalProperties: {}
        includes:
          type: array
          items:
            type: string
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
        counts:
          type: object
          properties:
            total_count:
              type: integer
            groups:
              type: object
              additionalProperties: {}
          required:
            - total_count
            - groups
      required:
        - success
        - operation
        - items
        - pagination
        - applied_filters
        - includes
        - meta
    McpError:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
                - nothing_to_update
                - not_found
                - relation_not_found
                - invalid_transition
                - limit_exceeded
                - payment_required
                - duplicate_rejected
                - conflict
                - delete_blocked
                - unauthorized
                - forbidden
                - rate_limited
                - internal_error
                - service_unavailable
                - not_implemented
            message:
              type: string
            recoverable:
              type: boolean
            suggestion:
              type: string
            field_errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: object
                  properties:
                    rule:
                      type: string
                    message:
                      type: string
                  required:
                    - rule
                    - message
            blockers:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    description: >-
                      Machine-readable blocker type (active_flow, pending_tasks,
                      …).
                  severity:
                    type: string
                    enum:
                      - hard
                      - soft
                    description: >-
                      hard = external action required; soft = acknowledge is
                      enough.
                  description:
                    type: string
                  entity_sid:
                    type: string
                    nullable: true
                  count:
                    type: integer
                  resolution:
                    type: string
                    description: 'Hard: tool name to call. Soft: code for acknowledge[].'
                  resolution_hint:
                    type: string
                required:
                  - type
                  - severity
                  - description
                  - entity_sid
                  - resolution
                  - resolution_hint
            context:
              type: object
              additionalProperties: {}
          required:
            - code
            - message
            - recoverable
        meta:
          type: object
          properties:
            trace_id:
              type: string
              description: UUID v7; same 128-bit value as the X-Trace-Id header.
            span_id:
              type: string
              pattern: ^[0-9a-f]{16}$
              description: 16 hex chars, root span of this request.
            timestamp:
              type: string
              description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
            duration_ms:
              type: integer
              minimum: 0
              description: Server-side wall clock.
            team_sid:
              type: string
              nullable: true
              description: >-
                The team this call ran in (the token team, or the team_sid
                override). Null when unauthenticated; absent from pre-2026-08-20
                backends.
            actor_type:
              type: string
              nullable: true
              description: >-
                user | agent | api_key | system. Null when unauthenticated;
                absent from pre-2026-08-20 backends.
          required:
            - trace_id
            - span_id
            - timestamp
            - duration_ms
      required:
        - success
        - error
  responses:
    McpClientError:
      description: >-
        MCP error envelope. `error.code` is one of validation_failed,
        nothing_to_update, not_found, relation_not_found, invalid_transition,
        limit_exceeded, payment_required, duplicate_rejected, conflict,
        delete_blocked, unauthorized, forbidden, rate_limited, not_implemented.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
          examples:
            validation_failed:
              summary: '422: a field of the request failed validation'
              value:
                success: false
                error:
                  code: validation_failed
                  message: Validation failed
                  recoverable: true
                  field_errors:
                    page_size:
                      - rule: max
                        message: The page size field must not be greater than 1000.
                meta:
                  trace_id: 019a7c2e-5b1d-7c3a-9f4e-2a6b8d0c1e3f
                  span_id: 5f0c9a2e7b4d1c38
                  timestamp: '2026-11-13T09:30:00Z'
                  duration_ms: 41
                  team_sid: ts_tm_Bv9nK4xP1sD7
                  actor_type: api_key
            unauthorized:
              summary: '401: no bearer token, or one that does not verify'
              value:
                success: false
                error:
                  code: unauthorized
                  message: Authentication required
                  recoverable: true
                  context:
                    reason: missing_or_invalid_token
                meta:
                  trace_id: 019a7c2e-5b1d-7c3a-9f4e-2a6b8d0c1e3f
                  span_id: 5f0c9a2e7b4d1c38
                  timestamp: '2026-11-13T09:30:00Z'
                  duration_ms: 41
                  team_sid: null
                  actor_type: null
    McpServerError:
      description: >-
        MCP error envelope with `error.code` internal_error or
        service_unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/McpError'
          examples:
            service_unavailable:
              summary: >-
                503: something the call depends on did not answer; the same call
                can be made again
              value:
                success: false
                error:
                  code: service_unavailable
                  message: 'Service unavailable: upstream unavailable'
                  recoverable: true
                  context:
                    reason: upstream_unavailable
                meta:
                  trace_id: 019a7c2e-5b1d-7c3a-9f4e-2a6b8d0c1e3f
                  span_id: 5f0c9a2e7b4d1c38
                  timestamp: '2026-11-13T09:30:00Z'
                  duration_ms: 41
                  team_sid: ts_tm_Bv9nK4xP1sD7
                  actor_type: api_key
            internal_error:
              summary: >-
                500: a fault on our side; a retry does not help, report
                meta.trace_id
              value:
                success: false
                error:
                  code: internal_error
                  message: Internal error
                  recoverable: false
                  context:
                    reason: internal_error
                meta:
                  trace_id: 019a7c2e-5b1d-7c3a-9f4e-2a6b8d0c1e3f
                  span_id: 5f0c9a2e7b4d1c38
                  timestamp: '2026-11-13T09:30:00Z'
                  duration_ms: 41
                  team_sid: ts_tm_Bv9nK4xP1sD7
                  actor_type: api_key
  securitySchemes:
    BearerJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token issued by gtm.service.id. Its `access_identity` claim
        carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is
        authoritative.
    TeamSid:
      type: apiKey
      in: header
      name: Team-SID
      description: >-
        Team scope for tokens that do not carry one. Ignored when the token
        already names a team.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.