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

# Search authorized synced mailbox headers with bounded cursor pagination. isDone covers stored records, not provider completeness

> Search authorized synced mailbox headers with bounded cursor pagination. isDone covers stored records, not provider completeness.



## OpenAPI

````yaml /api-reference/openapi.json get /email/inbox/search
openapi: 3.1.0
info:
  title: Dench API
  version: 1.0.0
  description: >-
    Versioned Dench workspace API. The operation registry is shared with the
    Dench CLI parity layer, so every CLI command maps to an endpoint here.
servers:
  - url: https://www.dench.com/api/v1
security: []
tags:
  - name: agent-config
    description: Agent Config operations.
  - name: approvals
    description: Approvals operations.
  - name: apps
    description: Apps operations.
  - name: auth
    description: Auth operations.
  - name: billing
    description: Billing operations.
  - name: browser
    description: Browser operations.
  - name: campaigns
    description: Campaigns operations.
  - name: chat
    description: Chat operations.
  - name: crm
    description: Crm operations.
  - name: email
    description: Email operations.
  - name: environments
    description: Environments operations.
  - name: files
    description: Files operations.
  - name: gateway
    description: Gateway operations.
  - name: lists
    description: Lists operations.
  - name: local
    description: Local operations.
  - name: meetings
    description: Meetings operations.
  - name: members
    description: Members operations.
  - name: memory
    description: Memory operations.
  - name: meta
    description: Meta operations.
  - name: notifications
    description: Notifications operations.
  - name: routines
    description: Routines operations.
  - name: secrets
    description: Secrets operations.
  - name: settings
    description: Settings operations.
  - name: workspace
    description: Workspace operations.
paths:
  /email/inbox/search:
    get:
      tags:
        - email
      summary: >-
        Search authorized synced mailbox headers with bounded cursor pagination.
        isDone covers stored records, not provider completeness
      description: >-
        Search authorized synced mailbox headers with bounded cursor pagination.
        isDone covers stored records, not provider completeness.
      operationId: email_inbox_search
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 50
        - name: cursor
          in: query
          required: false
          schema:
            type: string
        - name: mailbox
          in: query
          required: false
          schema:
            type: string
        - name: from
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 500
        - name: to
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 500
        - name: subject
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 500
        - name: query
          in: query
          required: false
          schema:
            description: >-
              Words that must all appear in the subject, sender or recipients
              (case-insensitive).
            type: string
            minLength: 1
            maxLength: 500
          description: >-
            Words that must all appear in the subject, sender or recipients
            (case-insensitive).
        - name: after
          in: query
          required: false
          schema:
            description: >-
              Inclusive Unix milliseconds; missing sentAt falls back to
              createdAt.
            type: number
          description: Inclusive Unix milliseconds; missing sentAt falls back to createdAt.
        - name: before
          in: query
          required: false
          schema:
            description: Exclusive Unix milliseconds.
            type: number
          description: Exclusive Unix milliseconds.
        - name: direction
          in: query
          required: false
          schema:
            type: string
            enum:
              - inbound
              - outbound
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: array
                    items:
                      type: object
                      properties:
                        messageHandle:
                          type: string
                        threadHandle:
                          type: string
                        mailboxId:
                          type: string
                        from:
                          type: object
                          properties:
                            email:
                              type: string
                            name:
                              type: string
                          required:
                            - email
                          additionalProperties: false
                        to:
                          type: array
                          items:
                            type: object
                            properties:
                              email:
                                type: string
                              name:
                                type: string
                            required:
                              - email
                            additionalProperties: false
                        subject:
                          type: string
                        at:
                          type: number
                        dateSource:
                          type: string
                          enum:
                            - sentAt
                            - createdAt
                        direction:
                          type: string
                          enum:
                            - inbound
                            - outbound
                        status:
                          type: string
                        hasAttachments:
                          type: boolean
                        headersTruncated:
                          type: boolean
                      required:
                        - messageHandle
                        - threadHandle
                        - mailboxId
                        - from
                        - to
                        - subject
                        - at
                        - dateSource
                        - direction
                        - status
                        - hasAttachments
                        - headersTruncated
                      additionalProperties: false
                  continueCursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                  isDone:
                    type: boolean
                  coverage:
                    type: object
                    properties:
                      source:
                        type: string
                        const: synced
                      scope:
                        type: string
                        const: mailbox_linked_messages
                      mailboxId:
                        type: string
                      mailboxEmail:
                        type: string
                      mailboxStatus:
                        type: string
                      ingestionMode:
                        type: string
                      phase:
                        type: string
                      syncStatus:
                        anyOf:
                          - type: string
                          - type: 'null'
                      lastPolledAt:
                        anyOf:
                          - type: number
                          - type: 'null'
                      lastBackfillCompletedAt:
                        anyOf:
                          - type: number
                          - type: 'null'
                      oldestSeenAt:
                        anyOf:
                          - type: number
                          - type: 'null'
                      backfillStatus:
                        anyOf:
                          - type: string
                          - type: 'null'
                      backfillCapped:
                        type: boolean
                      providerComplete:
                        type: boolean
                        const: false
                      privacyLimited:
                        type: boolean
                    required:
                      - source
                      - scope
                      - mailboxId
                      - mailboxEmail
                      - mailboxStatus
                      - ingestionMode
                      - phase
                      - syncStatus
                      - lastPolledAt
                      - lastBackfillCompletedAt
                      - oldestSeenAt
                      - backfillStatus
                      - backfillCapped
                      - providerComplete
                      - privacyLimited
                    additionalProperties: false
                  order:
                    type: string
                    const: sentAt_desc_then_undated
                required:
                  - page
                  - continueCursor
                  - isDone
                  - coverage
                  - order
                additionalProperties: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - DenchApiKey: []
        - AgentSession: []
components:
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Operation or resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
            - code
          properties:
            message:
              type: string
            type:
              type: string
            code:
              type: string
            details: {}
  securitySchemes:
    DenchApiKey:
      type: http
      scheme: bearer
      bearerFormat: DENCH_API_KEY
      description: >-
        Workspace-scoped Dench API key from workspace settings. This is the same
        key used by DENCH_API_KEY in sandboxes.
    AgentSession:
      type: http
      scheme: bearer
      bearerFormat: dch_agent_*
      description: >-
        Agent session token created by `dench signin`. Gateway-backed routes
        exchange this token for the workspace gateway key.

````

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