Skip to main content
GET
Get Ingestion Config Sync Status

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

config_id
string
required

The ID of the ingestion config.

Response

200 - application/json

Success

syncStatus
enum<string>

Status of the last/current sync.

Available options:
SYNC_STATUS_UNSPECIFIED,
SYNC_STATUS_NOT_STARTED,
SYNC_STATUS_RUNNING,
SYNC_STATUS_COMPLETED,
SYNC_STATUS_FAILED
lastSyncEndTime
string<date-time> | null

A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").

Example:

"2025-01-15T01:30:15.000Z"

firstSyncStartTime
string<date-time> | null

A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").

Example:

"2025-01-15T01:30:15.000Z"

currentPhase
enum<string>

Current phase when sync is running.

Available options:
INGESTION_SYNC_PHASE_UNSPECIFIED,
INGESTION_SYNC_PHASE_INGESTING_DATA,
INGESTION_SYNC_PHASE_EXTRACTING_SCHEMA,
INGESTION_SYNC_PHASE_INFERENCE
hasExternalEntities
boolean

Whether any external entities have been synced for this config.

hasFieldMappings
boolean

Whether any field mappings exist for this config.

hasPublishedEntities
boolean

Whether any published entities exist for this config.

isDeleting
boolean

Whether a deletion workflow is currently running.