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

# Get Connector Sync

> Get a connector sync by id.



## OpenAPI

````yaml GET /orgs/{org_id}/connectors/{connector_id}/syncs/{sync_id}
openapi: 3.1.0
info:
  title: Timbal Platform API
  description: Public API documentation for the Timbal platform
  license:
    name: ''
  version: 2.0.0
servers:
  - url: https://api.timbal.ai
    description: Production
  - url: https://api.dev.timbal.ai
    description: Development
security: []
tags:
  - name: ace
    description: Action Control Engine (ACE) operations
  - name: analytics
    description: Project analytics
  - name: billing
    description: Subscriptions, usage, and payment-related operations
  - name: content
    description: Re-sign stored content URLs
  - name: files
    description: File operations
  - name: iam
    description: IAM — actions, roles, users, and authorization introspection
  - name: k2
    description: Knowledge Bases v2 operations
  - name: orgs
    description: Organization operations
  - name: projects
    description: Project operations
  - name: runs
    description: Execution operations
  - name: templates
    description: Public project template catalog
  - name: users
    description: Authenticated user profile
paths:
  /orgs/{org_id}/connectors/{connector_id}/syncs/{sync_id}:
    get:
      tags:
        - connectors
      summary: '`GET /orgs/{org_id}/connectors/{connector_id}/syncs/{sync_id}`'
      description: Get a connector sync by id.
      operationId: get
      parameters:
        - name: org_id
          in: path
          required: true
          schema:
            type: string
        - name: connector_id
          in: path
          required: true
          schema:
            type: string
        - name: sync_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Sync detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncDetailRes'
        '403':
          description: Forbidden
        '404':
          description: Sync not found
      security:
        - bearer_auth: []
components:
  schemas:
    SyncDetailRes:
      type: object
      required:
        - sync
        - stats
        - recent_runs
      properties:
        recent_runs:
          type: array
          items:
            $ref: '#/components/schemas/SyncRunView'
        stats:
          $ref: '#/components/schemas/SyncStatsView'
        sync:
          $ref: '#/components/schemas/SyncView'
    SyncRunView:
      type: object
      description: One historical run of a sync, with derived timing.
      required:
        - job_id
        - state
        - rows_emitted
        - created_at
      properties:
        created_at:
          type: string
          format: date-time
        duration_ms:
          type:
            - integer
            - 'null'
          format: int64
        finished_at:
          type:
            - string
            - 'null'
          format: date-time
        job_id:
          type: string
        message:
          type:
            - string
            - 'null'
        rows_emitted:
          type: integer
          format: int64
        rows_per_sec:
          type:
            - number
            - 'null'
          format: double
        started_at:
          type:
            - string
            - 'null'
          format: date-time
        state:
          type: string
    SyncStatsView:
      type: object
      description: Rollup of a sync's run history (from its `ConnectorJobs`).
      required:
        - runs_total
        - runs_completed
        - runs_failed
        - rows_total
      properties:
        rows_total:
          type: integer
          format: int64
        runs_completed:
          type: integer
          format: int64
        runs_failed:
          type: integer
          format: int64
        runs_total:
          type: integer
          format: int64
    SyncView:
      type: object
      required:
        - id
        - connector_id
        - source_kind
        - connection_ref
        - source_schema
        - source_table
        - cursor_column
        - kb_uid
        - dest_table
        - interval_secs
        - enabled
        - has_cursor
        - created_at
        - updated_at
      properties:
        connection_ref:
          type: string
        connector_id:
          type: string
        created_at:
          type: string
          format: date-time
        cursor_column:
          type: string
        dest_table:
          type: string
        enabled:
          type: boolean
        has_cursor:
          type: boolean
          description: >-
            Whether a cursor checkpoint has been committed (i.e. the sync has
            pulled

            at least one batch). The raw cursor is intentionally not exposed.
        id:
          type: string
        interval_secs:
          type: integer
          format: int32
        kb_uid:
          type: string
        last_run_at:
          type:
            - string
            - 'null'
          format: date-time
        last_state:
          type:
            - string
            - 'null'
        last_success_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Last time a run reached `completed`; `null` if it has never
            succeeded.
        name:
          type:
            - string
            - 'null'
        seconds_since_success:
          type:
            - integer
            - 'null'
          format: int64
          description: >-
            Freshness/lag: seconds since the last successful run. `null` if
            never

            succeeded. Compare against `interval_secs` to spot a stalling sync.
        source_kind:
          type: string
        source_schema:
          type: string
        source_table:
          type: string
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: >-
        Timbal API key. Obtain your API key from the Timbal platform settings.
        See [Authentication](/api-reference/authentication) for more
        information.

````