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

# Sync status

> Get the status of specified sync(s) (for a given connection or all applicable connections if no connection is specified)

<Info>
  Requires an API key with the `environment:syncs:read` scope. [Learn more about API key scopes](/reference/backend/http-api/api-keys#scopes).
</Info>

The response includes the current `checkpoint` for each sync, which tracks how far the sync has progressed. Learn more about [checkpoints](/guides/functions/syncs/checkpoints).


## OpenAPI

````yaml GET /sync/status
openapi: 3.1.0
info:
  title: Nango API
  description: Nango API specs used to authorize & sync data with external APIs.
  version: 1.0.0
servers:
  - url: https://api.nango.dev
    description: Production server
  - url: http://localhost:3003
    description: Local server
security:
  - bearerAuth: []
externalDocs:
  url: https://nango.dev/docs/reference/backend/http-api/authentication
paths:
  /sync/status:
    get:
      summary: Get sync status
      description: >-
        Get the status of specified sync(s) (for a given connection or all
        applicable connections if no connection is specified)
      parameters:
        - name: provider_config_key
          in: query
          required: true
          schema:
            type: string
          description: The ID of the integration you established within Nango
        - name: syncs
          in: query
          required: true
          schema:
            type: string
          description: >-
            The name of the syncs you want to fetch a status for, as a
            comma-separated list. Pass in "*" to return all syncs for the
            integration. For variants, use the format "syncName::variantName".
        - name: connection_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            The ID of the connection. If omitted, all connections will be
            surfaced.
      responses:
        '200':
          description: Successfully returned a list of syncs and their status
          content:
            application/json:
              schema:
                type: object
                properties:
                  syncs:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The unique identifier for the sync.
                        connection_id:
                          type: string
                          description: The ID of the connection
                        name:
                          type: string
                          description: The name of the sync.
                        variant:
                          type: string
                          description: The variant of the sync.
                        status:
                          type: string
                          enum:
                            - RUNNING
                            - PAUSED
                            - STOPPED
                            - SUCCESS
                            - ERROR
                          description: The current status of the sync.
                        type:
                          deprecated: true
                          type: string
                          description: The most recent sync type completed
                          enum:
                            - INCREMENTAL
                            - INITIAL
                        finishedAt:
                          type: string
                          description: ISO string of the most recently completed sync
                        nextScheduledSyncAt:
                          type: string
                          description: ISO string of the next scheduled sync time
                        frequency:
                          type: string
                          description: The execution frequency of the sync
                        latestResult:
                          type: object
                          description: >-
                            Additional information regarding the latest result
                            of the sync. Contains a model name with added,
                            updated and deleted records
                        recordCount:
                          type: object
                          description: >-
                            Total count of records for each model synced by the
                            sync
                        checkpoint:
                          anyOf:
                            - type: object
                            - type: 'null'
                          description: >-
                            Last checkpoint saved during sync execution. Null if
                            no checkpoint exists.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StdError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StdError'
  schemas:
    StdError:
      type: object
      additionalProperties: false
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
            errors:
              type: array
              items:
                type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: The secret key from your Nango environment.

````