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

# Get mailbox changes

> Returns message changes in the legacy shape when `types` is omitted. Pass a comma-separated `types` list for a typed state map.



## OpenAPI

````yaml /openapi-app.json get /mailbox/changes
openapi: 3.1.0
info:
  description: Programmatic access to your Sendmux email infrastructure.
  title: Sendmux API
  version: 1.0.0
servers:
  - description: API v1
    url: https://app.sendmux.ai/api/v1
security:
  - bearerAuth: []
paths:
  /mailbox/changes:
    get:
      tags:
        - Mailbox API
      summary: Get mailbox changes
      description: >-
        Returns message changes in the legacy shape when `types` is omitted.
        Pass a comma-separated `types` list for a typed state map.
      operationId: mailboxGetChanges
      parameters:
        - in: query
          name: since_state
          required: false
          schema:
            description: Legacy message state cursor to resume from.
            type: string
        - in: query
          name: types
          required: false
          schema:
            description: >-
              Comma-separated list: messages, folders, threads, submissions,
              identities, quotas.
            type: string
        - in: query
          name: messages_since_state
          required: false
          schema:
            description: Message state cursor to resume from.
            type: string
        - in: query
          name: folders_since_state
          required: false
          schema:
            description: Folder state cursor to resume from.
            type: string
        - in: query
          name: threads_since_state
          required: false
          schema:
            description: Thread state cursor to resume from.
            type: string
        - in: query
          name: submissions_since_state
          required: false
          schema:
            description: Submission state cursor to resume from.
            type: string
        - in: query
          name: identities_since_state
          required: false
          schema:
            description: Identity state cursor to resume from.
            type: string
        - in: query
          name: quotas_since_state
          required: false
          schema:
            description: Quota state cursor to resume from.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Maximum change records to return (default 50, max 500).
            maximum: 500
            minimum: 1
            type: integer
        - description: >-
            Mailbox public ID to target when the credential grants access to
            more than one mailbox. Omit when the credential is scoped to exactly
            one mailbox.
          in: query
          name: mailbox_id
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/MailboxChangesResponse'
                  - $ref: '#/components/schemas/MailboxTypedChangesResponse'
          description: Mailbox changes
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid sync state
      security:
        - bearerAuth: []
components:
  schemas:
    MailboxChangesResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - properties:
            data:
              $ref: '#/components/schemas/MailboxChanges'
            meta:
              $ref: '#/components/schemas/ResponseMeta'
          required:
            - data
          type: object
      unevaluatedProperties: false
    MailboxTypedChangesResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - properties:
            data:
              $ref: '#/components/schemas/MailboxTypedChanges'
            meta:
              $ref: '#/components/schemas/ResponseMeta'
          required:
            - data
          type: object
      unevaluatedProperties: false
    ApiError:
      additionalProperties: false
      properties:
        error:
          additionalProperties: false
          properties:
            code:
              description: Machine-readable error code
              enum:
                - invalid_parameter
                - missing_parameter
                - authentication_required
                - insufficient_permissions
                - not_found
                - conflict
                - limit_exceeded
                - idempotency_conflict
                - payload_too_large
                - validation_error
                - rate_limit_exceeded
                - service_unavailable
                - internal_error
              example: invalid_parameter
              type: string
            doc_url:
              description: Link to relevant documentation
              type: string
            errors:
              description: >-
                Accumulated per-field issues for validation errors. Only present
                on 400/422 responses.
              items:
                $ref: '#/components/schemas/ApiErrorDetail'
              type: array
            message:
              description: Human-readable error description
              type: string
            param:
              description: The parameter that caused the error
              type: string
            retryable:
              description: >-
                Whether the caller may safely retry this request. 4xx are
                typically false (except 429); 5xx are typically true.
              example: false
              type: boolean
          required:
            - code
            - message
            - retryable
          type: object
        meta:
          additionalProperties: false
          properties:
            request_id:
              example: req_clxxxxxxxxxxxxxxxxxxxxxxxxx
              type: string
          required:
            - request_id
          type: object
        ok:
          enum:
            - false
          type: boolean
      required:
        - ok
        - error
        - meta
      type: object
    SuccessEnvelope:
      properties:
        meta:
          additionalProperties: {}
          properties: {}
          type: object
        ok:
          enum:
            - true
          type: boolean
      required:
        - ok
        - meta
      type: object
    MailboxChanges:
      additionalProperties: false
      properties:
        created:
          items:
            type: string
          type: array
        destroyed:
          items:
            type: string
          type: array
        has_more:
          type: boolean
        new_state:
          type: string
        old_state:
          type:
            - string
            - 'null'
        sync_required:
          description: >-
            When true, refetch this resource list instead of applying the
            incremental arrays.
          type: boolean
        updated:
          items:
            type: string
          type: array
        updated_properties:
          items:
            type: string
          type: array
      required:
        - old_state
        - new_state
        - has_more
        - created
        - updated
        - destroyed
      type: object
    ResponseMeta:
      additionalProperties: false
      properties:
        request_id:
          example: req_clxxxxxxxxxxxxxxxxxxxxxxxxx
          type: string
      required:
        - request_id
      type: object
    MailboxTypedChanges:
      additionalProperties: false
      properties:
        types:
          additionalProperties: false
          properties:
            folders:
              $ref: '#/components/schemas/MailboxChanges'
            identities:
              $ref: '#/components/schemas/MailboxChanges'
            messages:
              $ref: '#/components/schemas/MailboxChanges'
            quotas:
              $ref: '#/components/schemas/MailboxChanges'
            submissions:
              $ref: '#/components/schemas/MailboxChanges'
            threads:
              $ref: '#/components/schemas/MailboxChanges'
          type: object
      required:
        - types
      type: object
    ApiErrorDetail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Machine-readable issue code from the validator (e.g. zod issue
            code).
          example: invalid_string
          type: string
        field:
          description: Dot-path of the offending request field.
          example: recipient.email
          type: string
        message:
          description: Human-readable issue description.
          type: string
      required:
        - field
        - code
        - message
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: API Key
      description: >-
        Sendmux API key. Use a root API key for Management API routes, or a
        mailbox credential for Mailbox API routes. Obtain keys from the
        dashboard under API Keys.
      scheme: bearer
      type: http

````