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

# Get the status of a dbt sync



## OpenAPI

````yaml /api-reference/api.yaml get /api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}
openapi: 3.1.0
info:
  title: Cube Platform API
  version: 1.0.0
  description: >-
    Programmatically manage Cube: deployments and everything scoped to them

    (environments, folders, reports, workbooks, notifications, workspace, and
    agents),

    plus account-level users, groups, policies, embedding, and AI settings.
    Data-model

    authoring, dev mode, branches, and uploads live under /build/api/v1 — same
    host and

    token, routed to the build pods.
servers:
  - url: https://{tenant}.cubecloud.dev
    description: Your tenant host. Replace the whole host if you use a custom domain.
    variables:
      tenant:
        default: your-tenant
        description: Your Cube tenant subdomain
security:
  - bearerAuth: []
tags:
  - name: Deployments
  - name: Deployment Creation
  - name: Environments
  - name: Env Variables
  - name: Regions
  - name: Data Model
  - name: Data Model Uploads
  - name: GitHub
  - name: GitHub Connection
  - name: dbt Sync
  - name: Folders
  - name: Reports
  - name: Workbooks
  - name: Notifications
  - name: Workspace
  - name: Users Admin
  - name: User Attributes
  - name: User Attribute Values
  - name: Tenant Settings
  - name: OAuth Integrations
  - name: User OAuth Tokens
  - name: OIDC Token Configs
  - name: App Theme
  - name: Embed
  - name: Embed Tenants
  - name: Dashboard Embed Access
  - name: OpenAPI Spec
paths:
  /api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}:
    get:
      tags:
        - dbt Sync
      summary: Get the status of a dbt sync
      operationId: getDbtSyncStatus
      parameters:
        - in: path
          name: deploymentId
          required: true
          schema:
            type: integer
        - in: path
          name: syncJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DbtSyncStatusResponse'
          description: ''
components:
  schemas:
    DbtSyncStatusResponse:
      properties:
        error:
          oneOf:
            - type: string
              description: Why the sync stopped. Present only when the status is FAILED.
            - type: 'null'
        progress:
          $ref: '#/components/schemas/DbtSyncProgress'
        status:
          description: >-
            One of INITIALIZING, CREATING_SANDBOX, UPLOADING_PROJECT,
            INSTALLING_DEPENDENCIES, RUNNING_DBT_DEPS, COMPILING_DBT,
            PROCESSING_MANIFEST, WRITING_CUBE_FILES, FINALIZING, COMPLETED,
            FAILED. COMPLETED and FAILED are the only terminal values: poll
            until one of them, then read the result. Treat any unrecognized
            value as still running.
          type: string
        syncJobId:
          type: string
        updatedAt:
          description: When this status was last updated, as an ISO 8601 timestamp.
          type: string
      required:
        - syncJobId
        - status
        - progress
        - updatedAt
      type: object
    DbtSyncProgress:
      properties:
        message:
          oneOf:
            - type: string
              description: Human-readable description of what the sync is doing right now.
            - type: 'null'
        percentComplete:
          description: >-
            Rough completion percentage derived from the stage. Progress
            reporting only — do not gate on it; gate on the status reaching
            COMPLETED or FAILED.
          type: integer
        stage:
          description: >-
            The stage the sync is currently in, from the same set of values as
            the sync status.
          type: string
      required:
        - stage
        - percentComplete
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Token authentication. Send `Authorization: Bearer <YOUR_TOKEN>`.'

````