Get sync status

GET /api/v1/businesses/{business_id}/sync

Get the current Teal sync status for a business. Lightweight endpoint for polling.

Operation ID: get_business_sync_status_api_v1_businesses__business_id__sync_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

business_id string required

Responses

200 Successful Response

Schema: SyncStatus

status string required

Sync status: 'syncing', 'completed', or 'nothing_to_sync'

One of: syncing, completed, nothing_to_sync

last_synced string

ISO timestamp of last successful sync

sync_in_progress boolean

Whether a teal-sync task is currently running (from tasks table)

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/businesses/{business_id}/sync

bash

curl -X GET 'https://api.ondayzero.com/api/v1/businesses/{business_id}/sync' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/businesses/{business_id}/sync', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/businesses/{business_id}/sync", headers=headers)
data = response.json()