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

# Get Chatwoot sync progress

> Returns the current sync progress for a device



## OpenAPI

````yaml /openapi.yml get /chatwoot/sync/status
openapi: 3.0.0
info:
  title: WhatsApp API MultiDevice
  version: 9.7.0
  description: |
    This API is used for sending whatsapp via API.

    The web dashboard is a separate project (gowa-ui); the server downloads its
    latest release asset and serves it at `/` (or returns a JSON banner when
    APP_UI_ENABLED=false).

    Device scoping:
    - Send `X-Device-Id` on all device-scoped REST calls.
    - WebSocket: connect to `/ws?device_id=<id>`.
    - WebSocket auth (when basic auth is enabled): browsers cannot set an
      Authorization header on WebSocket connections, so also pass
      `&authorization=<base64(user:pass)>` in the query string. Use TLS in
      production since the credential is visible in the URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Initial Connection to Whatsapp server
  - name: device
    description: Device management for multi-device support
  - name: user
    description: Getting information
  - name: send
    description: Send Message (Text/Image/File/Video).
  - name: message
    description: Message manipulation (revoke/react/update).
  - name: call
    description: Call management (reject incoming calls)
  - name: chat
    description: Chat conversations and messaging
  - name: group
    description: Group setting
  - name: newsletter
    description: newsletter setting
  - name: chatwoot
    description: Chatwoot integration for customer support
paths:
  /chatwoot/sync/status:
    get:
      tags:
        - chatwoot
      summary: Get Chatwoot sync progress
      description: Returns the current sync progress for a device
      operationId: chatwootSyncStatus
      parameters:
        - name: device_id
          in: query
          description: Device ID to check sync status for
          schema:
            type: string
      responses:
        '200':
          description: Sync status retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatwootSyncStatusResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
components:
  schemas:
    ChatwootSyncStatusResponse:
      type: object
      properties:
        status:
          type: integer
          example: 200
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Sync status retrieved
        results:
          type: object
          properties:
            device_id:
              type: string
              example: my-device-id
            status:
              type: string
              enum:
                - idle
                - running
                - completed
                - failed
              example: running
            total_chats:
              type: integer
              example: 10
            synced_chats:
              type: integer
              example: 5
            total_messages:
              type: integer
              example: 100
            synced_messages:
              type: integer
              example: 50
            failed_messages:
              type: integer
              example: 2
            current_chat:
              type: string
              example: 628123456789@s.whatsapp.net
            started_at:
              type: string
              format: date-time
            completed_at:
              type: string
              format: date-time
            error:
              type: string
    ErrorBadRequest:
      type: object
      properties:
        code:
          type: string
          example: 400
          description: HTTP Status Code
        message:
          type: string
          example: field cannot be blank
          description: Detail error message
        results:
          type: object
          example: null
          description: additional data
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

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