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

# Get sync log by ID

> Get a single sync log in a given workspace.



## OpenAPI

````yaml https://api.qontext.ai/docs-json get /workspaces/{workspaceId}/sync-logs/{id}
openapi: 3.0.0
info:
  title: Qontext API
  description: API to ingest and retrieve data to enable contextualised AI.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.qontext.ai
    description: Production
security: []
tags: []
paths:
  /workspaces/{workspaceId}/sync-logs/{id}:
    get:
      tags:
        - Sync Logs
      summary: Get sync log by ID
      description: Get a single sync log in a given workspace.
      operationId: SyncLogsController_findOne
      parameters:
        - name: workspaceId
          required: true
          in: path
          description: The unique identifier of the workspace the sync log belongs to.
          schema:
            example: ws_123e4567-e89b-12d3-a456-426614174000
            type: string
        - name: id
          required: true
          in: path
          description: The unique identifier of the sync log.
          schema:
            example: sync_42a17e56-b98d-4fd9-b2ce-5a8b12d7f9ad
            type: string
      responses:
        '200':
          description: Sync log successfully fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncLog'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestDto'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedDto'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenDto'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorDto'
      security:
        - X-API-Key:
            - X-API-Key
        - bearer: []
components:
  schemas:
    SyncLog:
      type: object
      properties:
        id:
          type: object
          description: Unique identifier for the sync log
          example: sync_123e4567-e89b-12d3-a456-426614174000
        ingestionPipelineId:
          type: object
          description: ID of the ingestion pipeline this sync log belongs to
          example: pipe_123e4567-e89b-12d3-a456-426614174000
        knowledgeGraphId:
          type: object
          description: ID of the knowledge graph this sync log relates to
          example: kg_123e4567-e89b-12d3-a456-426614174000
        workspaceId:
          type: string
          description: ID of the workspace this sync log belongs to
          example: ws_123e4567-e89b-12d3-a456-426614174000
        type:
          type: string
          description: Type of sync operation
          example: full_sync
          enum:
            - full_sync
            - live_sync
            - incremental_sync
            - manual_sync
        status:
          type: string
          description: Status of the sync operation
          example: completed
          enum:
            - pending
            - preparing
            - data_fetching
            - ingesting
            - completed
            - failed
            - stopped
            - skipped
        startedAt:
          type: object
          description: When the sync operation started
          example: '2021-01-01T00:00:00.000Z'
        completedAt:
          type: object
          description: When the sync operation completed
          example: '2021-01-01T00:00:00.000Z'
        errorMessage:
          type: object
          description: Error message if the sync operation failed
          example: Failed to connect to data source
        userFacingErrorMessage:
          type: object
          description: >-
            User-facing error message shown in the UI when a sync fails due to a
            permanent issue
          example: This website is not supported and cannot be synced.
        temporalWorkflowId:
          type: object
          description: Temporal workflow ID for this sync
          example: sync-sync_123e4567-e89b-12d3-a456-426614174000
        temporalRunId:
          type: object
          description: Temporal workflow run ID for this sync
          example: run_123e4567-e89b-12d3-a456-426614174000
        preparationMetadata:
          type: object
          description: Preparation metadata including record type counts
          example:
            contacts: 1000
            deals: 500
            companies: 300
        totalRecordsToIngest:
          type: object
          description: Total number of records that need to be ingested
          example: 1800
        recordsIngested:
          type: object
          description: Number of records successfully ingested
          example: 450
        preparationCompletedAt:
          type: object
          description: When the preparation step was completed
          example: '2021-01-01T00:00:00.000Z'
        minDate:
          type: object
          description: >-
            The minimum date for the sync operation. Only records changed after
            this date will be synced.
          example: '2021-01-01T00:00:00.000Z'
        manualSyncData:
          type: object
          description: Data for manual sync
          example:
            manualSyncData: manual_sync_data
        correlationId:
          type: object
          description: Correlation ID (W3C trace-id) for end-to-end tracing
          example: 4fd0b6c2a4d1e0f8a2b9c3d4e5f60718
        createdAt:
          type: object
          description: The date and time the sync log was created
          example: '2021-01-01T00:00:00.000Z'
        updatedAt:
          type: object
          description: The date and time the sync log was last updated
          example: '2021-01-01T00:00:00.000Z'
      required:
        - id
        - ingestionPipelineId
        - knowledgeGraphId
        - workspaceId
        - type
        - status
        - startedAt
        - completedAt
        - errorMessage
        - userFacingErrorMessage
        - temporalWorkflowId
        - temporalRunId
        - preparationMetadata
        - totalRecordsToIngest
        - recordsIngested
        - preparationCompletedAt
        - minDate
        - manualSyncData
        - correlationId
        - createdAt
        - updatedAt
    BadRequestDto:
      type: object
      properties:
        message:
          description: Array of specific error messages
          example:
            - <error message>
            - <error message>
          type: array
          items:
            type: string
        error:
          type: string
          description: Error Message
          example: Bad Request
        statusCode:
          type: number
          description: Status Code
          example: 400
          default: 400
      required:
        - message
        - error
        - statusCode
    UnauthorizedDto:
      type: object
      properties:
        message:
          type: string
          description: String or array of strings with specific error message(s)
          example: <error message(s)>
        error:
          type: string
          description: Error Message
          example: Unauthorized
        statusCode:
          type: number
          description: Status Code
          example: 401
          default: 401
      required:
        - message
        - error
        - statusCode
    ForbiddenDto:
      type: object
      properties:
        message:
          type: string
          description: String or array of strings with specific error message(s)
          example: <error message(s)>
        error:
          type: string
          description: Error Message
          example: Forbidden
        statusCode:
          type: number
          description: Status Code
          example: 403
          default: 403
      required:
        - message
        - error
        - statusCode
    InternalServerErrorDto:
      type: object
      properties:
        error:
          type: string
          description: Error Message
          example: Internal Server Error
        statusCode:
          type: number
          description: Status Code
          example: 500
          default: 500
      required:
        - error
        - statusCode
  securitySchemes:
    X-API-Key:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for the Qontext API

````