> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.polytomic.com/2024-02-08/api-reference/bulk-sync/get-status/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.polytomic.com/_mcp/server.

# Get Bulk Sync Status

GET https://app.polytomic.com/api/bulk/syncs/{id}/status

Returns the current status of a bulk sync.

The response includes the sync's current active/inactive state together with
information about the most recent execution — its status, start time, and any
errors — making this endpoint well-suited for health checks and monitoring
dashboards.

For the complete execution history, use
[`GET /api/bulk/syncs/{id}/executions`](../../../../../api-reference/bulk-sync/executions/list).
For the full details of a specific run, including per-schema breakdowns, use
[`GET /api/bulk/syncs/{id}/executions/{exec_id}`](../../../../../api-reference/bulk-sync/executions/get).

Reference: https://apidocs.polytomic.com/api-reference/bulk-sync/get-status

## Authentication

- `Authorization` header (basic auth, required) — This is the Polytomic deployment key (on-premises only)
- `Authorization` header (bearer token, required) — This is the Polytomic API key

## Request

### Path parameters

- `id` (string, required) — Unique identifier of the bulk sync.

## Response

### 200

OK

- `data` (V3BulkSyncStatusResponse, optional)

## Errors

### 401 Unauthorized Error

Unauthorized

- `code` (integer, optional) — Application-specific error code.
- `context` (map from string to any, optional) — Application context.
- `error` (string, optional) — Error message.
- `status` (string, optional) — Status text.

### 404 Not Found Error

Not Found

- `key` (string, optional)
- `message` (string, optional)
- `metadata` (map from string to any, optional)
- `status` (integer, optional)

### 500 Internal Server Error

Internal Server Error

- `key` (string, optional)
- `message` (string, optional)
- `metadata` (map from string to any, optional)
- `status` (integer, optional)

## Types

### V3BulkSyncStatusResponse

- `current_execution` (V3BulkSyncExecution, optional)
- `ingestion_status` (V3BulkSyncIngestionStatus, optional)
- `last_execution` (V3BulkSyncExecution, optional)
- `next_execution_time` (string, optional, nullable)

### V3BulkSyncExecution

- `completed_at` (string, optional, nullable)
- `created_at` (string, optional)
- `error_count` (long, optional)
- `fetch_mode` (enum, optional) — How the data is fetched. 'none' is normal operation for Polytomic. 'incremental' and 'full' apply to syncs from Salesforce. 'incremental' indicates the data is synced incrementally using record modification time. 'full' is necessary to catch up to the latest values for formula fields and rollup fields whose updates don't show up in incremental runs due to limitations in Salesforce.
  - Allowed values: `none`, `incremental`, `full`
- `id` (string, optional)
- `is_partial` (boolean, optional)
- `is_resync` (boolean, optional)
- `is_test` (boolean, optional)
- `output_disposition` (enum, optional)
  - Allowed values: `retain`, `truncate`, `rebuild`
- `record_count` (long, optional)
- `schemas` (list of V3BulkSyncSchemaExecution, optional, nullable)
- `started_at` (string, optional, nullable)
- `status` (enum, optional)
  - Allowed values: `created`, `scheduled`, `running`, `exporting`, `canceling`, `canceled`, `completed`, `failed`, `processing`, `errors`, `interrupted`
- `status_message` (string, optional)
- `type` (string, optional)
- `updated_at` (string, optional)
- `version` (string, optional) — Polytomic version which last ran this execution.
- `warning_count` (long, optional)

### V3BulkSyncIngestionStatus

- `enabled` (boolean, optional)
- `highwater_mark` (string, optional)
- `is_running` (boolean, optional)
- `position` (string, optional)
- `position_time` (string, optional, nullable)
- `status` (enum, optional) — The health status of CDC ingestion for a bulk sync. 'ok' means ingestion is operating normally. 'warning' indicates a non-fatal issue. 'error' indicates a potentially fatal ingestion error.
  - Allowed values: `ok`, `warning`, `error`
- `status_message` (string, optional)
- `updated_at` (string, optional)

### V3BulkSyncSchemaExecution

- `completed_at` (string, optional, nullable)
- `created_at` (string, optional)
- `error_count` (long, optional)
- `output_name` (string, optional)
- `record_count` (long, optional)
- `schema` (string, optional)
- `started_at` (string, optional, nullable)
- `status` (enum, optional)
  - Allowed values: `created`, `scheduled`, `running`, `exporting`, `canceled`, `completed`, `failed`, `interrupted`, `processing`
- `status_message` (string, optional)
- `updated_at` (string, optional)
- `version` (string, optional) — Polytomic version which last ran this schema execution.
- `warning_count` (long, optional)

## Examples

**Response**

```json
{
  "data": {
    "current_execution": {
      "completed_at": "2023-04-25T12:00:00Z",
      "created_at": "2023-04-25T12:00:00Z",
      "error_count": 0,
      "fetch_mode": "none",
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "is_partial": false,
      "is_resync": false,
      "is_test": false,
      "output_disposition": "retain",
      "record_count": 1000,
      "schemas": [
        {
          "completed_at": "2023-04-25T12:00:00Z",
          "created_at": "2023-04-25T12:00:00Z",
          "error_count": 0,
          "output_name": "contact",
          "record_count": 1000,
          "schema": "contact",
          "started_at": "2023-04-25T12:00:00Z",
          "status": "created",
          "status_message": "string",
          "updated_at": "2023-04-25T12:00:00Z",
          "version": "rel2026.08.05.06~1a2b3c4",
          "warning_count": 0
        }
      ],
      "started_at": "2023-04-25T12:00:00Z",
      "status": "created",
      "status_message": "string",
      "type": "scheduled",
      "updated_at": "2023-04-25T12:00:00Z",
      "version": "rel2026.08.05.06~1a2b3c4",
      "warning_count": 0
    },
    "ingestion_status": {
      "enabled": true,
      "highwater_mark": "string",
      "is_running": true,
      "position": "string",
      "position_time": "2024-01-15T09:30:00Z",
      "status": "ok",
      "status_message": "string",
      "updated_at": "2024-01-15T09:30:00Z"
    },
    "last_execution": {
      "completed_at": "2023-04-25T12:00:00Z",
      "created_at": "2023-04-25T12:00:00Z",
      "error_count": 0,
      "fetch_mode": "none",
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "is_partial": false,
      "is_resync": false,
      "is_test": false,
      "output_disposition": "retain",
      "record_count": 1000,
      "schemas": [
        {
          "completed_at": "2023-04-25T12:00:00Z",
          "created_at": "2023-04-25T12:00:00Z",
          "error_count": 0,
          "output_name": "contact",
          "record_count": 1000,
          "schema": "contact",
          "started_at": "2023-04-25T12:00:00Z",
          "status": "created",
          "status_message": "string",
          "updated_at": "2023-04-25T12:00:00Z",
          "version": "rel2026.08.05.06~1a2b3c4",
          "warning_count": 0
        }
      ],
      "started_at": "2023-04-25T12:00:00Z",
      "status": "created",
      "status_message": "string",
      "type": "scheduled",
      "updated_at": "2023-04-25T12:00:00Z",
      "version": "rel2026.08.05.06~1a2b3c4",
      "warning_count": 0
    },
    "next_execution_time": "2023-04-25T12:00:00Z"
  }
}
```

**SDK Code**

```python
import requests

url = "https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status"

headers = {
    "X-Polytomic-Version": "X-Polytomic-Version"
}

response = requests.get(url, headers=headers, auth=("<username>", "<password>"))

print(response.json())
```

```javascript
const url = 'https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status';
const credentials = btoa("<username>:<password>");

const options = {
  method: 'GET',
  headers: {
    'X-Polytomic-Version': 'X-Polytomic-Version',
    Authorization: `Basic ${credentials}`
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Polytomic-Version", "X-Polytomic-Version")
	req.SetBasicAuth("<username>", "<password>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Polytomic-Version"] = 'X-Polytomic-Version'
request.basic_auth("<username>", "<password>")

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status")
  .header("X-Polytomic-Version", "X-Polytomic-Version")
  .basicAuth("<username>", "<password>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status', [
  'headers' => [
    'X-Polytomic-Version' => 'X-Polytomic-Version',
  ],
    'auth' => ['<username>', '<password>'],
]);

echo $response->getBody();
```

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Polytomic-Version", "X-Polytomic-Version");

IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = [
  "X-Polytomic-Version": "X-Polytomic-Version",
  "Authorization": "Basic \(credentials)"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/status")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```