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

# CRM Sync Status

> Get the status and progress counters of a CRM sync run.



## OpenAPI

````yaml GET /trigger/crm-sync/{id}
openapi: 3.1.0
info:
  title: OpenAPI Lonescale
  description: A sample API for Lonescale
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://public-api.lonescale.com
security:
  - ApiKeyAuth: []
paths:
  /trigger/crm-sync/{id}:
    get:
      description: Get the status and progress counters of a CRM sync run.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The run id returned by POST /trigger/crm-sync
      responses:
        '200':
          description: Run status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmSyncRunStatus'
        '401':
          description: Invalid or missing authentication credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthError'
              example:
                message: Invalid API Key
                error: Unauthorized
                statusCode: 401
        '404':
          description: Run not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: Run not found
                error: Not Found
                statusCode: 404
components:
  schemas:
    CrmSyncRunStatus:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
          enum:
            - processing
            - finished
        total:
          type: integer
        processed:
          type: integer
          description: Records synced successfully
        failed:
          type: integer
          description: Records that failed after retries
    AuthError:
      required:
        - message
        - error
        - statusCode
      type: object
      properties:
        message:
          type: string
          example: Invalid API Key
        error:
          type: string
          example: Unauthorized
        statusCode:
          type: integer
          example: 401
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Provide your API key in the x-api-key header.

````