---
type: api
title: Get a connector sync job
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/operation/operation-connector-sync-job-get
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/elasticsearch/operation/operation-connector-sync-job-get
products:
  - Elasticsearch
---

# Get a connector sync job

Availability: 8.12+

## Paths

- `GET` `/_connector/_sync_job/{connector_sync_job_id}`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#basicauth)
- [Bearer auth](/elastic/docs-builder/docs/4371/api/doc/elasticsearch/authentication#bearerauth)

#### Path Parameters

- `connector_sync_job_id` (string Id)
  The unique identifier of the connector sync job

## Response

`application/json`

- `cancelation_requested_at` (DateTime)
- `canceled_at` (DateTime)
- `completed_at` (DateTime)
- `connector` ({} SyncJobConnectorReference)
  - `configuration` (ConnectorConfiguration)
  - `filtering` ({} FilteringRules)
    - `advanced_snippet` ({} FilteringAdvancedSnippet)
      - `created_at` (DateTime)
      - `updated_at` (DateTime)
      - `value` (object)
    - `rules` ([] FilteringRule)
      - `created_at` (DateTime)
      - `field` (string Field)
      - `id` (string Id)
      - `order` (number)
      - `policy` (enum FilteringPolicy)
        Values: `exclude`, `include`
      - `rule` (enum FilteringRuleRule)
        Values: `contains`, `ends_with`, `equals`, `regex`, `starts_with`, `>`, `<`
      - `updated_at` (DateTime)
      - `value` (string)
    - `validation` ({} FilteringRulesValidation)
      - `errors` ([] FilteringValidation)
        - `ids` ([] string Id)
        - `messages` ([] string)
      - `state` (enum FilteringValidationState)
        Values: `edited`, `invalid`, `valid`
  - `id` (string Id)
  - `index_name` (string)
  - `language` (string)
  - `pipeline` ({} IngestPipelineParams)
    - `extract_binary_content` (boolean)
    - `name` (string)
    - `reduce_whitespace` (boolean)
    - `run_ml_inference` (boolean)
  - `service_type` (string)
  - `sync_cursor` (object)
- `created_at` (DateTime)
- `deleted_document_count` (number)
- `error` (string)
- `id` (string Id)
- `indexed_document_count` (number)
- `indexed_document_volume` (number)
- `job_type` (enum SyncJobType)
  Values: `full`, `incremental`, `access_control`
- `last_seen` (DateTime)
- `metadata` (map string to object)
- `started_at` (DateTime)
- `status` (enum SyncStatus)
  Values: `canceling`, `canceled`, `completed`, `error`, `in_progress`, `pending`, `suspended`
- `total_document_count` (number)
- `trigger_method` (enum SyncJobTriggerMethod)
  Values: `on_demand`, `scheduled`
- `worker_hostname` (string)
## Code Examples

#### Console

```console
GET _connector/_sync_job/my-connector-sync-job
```

#### JavaScript

```javascript
const response = await client.connector.syncJobGet({
  connector_sync_job_id: "my-connector-sync-job",
});
```

#### Python

```python
resp = client.connector.sync_job_get(
    connector_sync_job_id="my-connector-sync-job",
)
```

#### curl

```curl
curl -X GET "$ELASTICSEARCH_URL/_connector/_sync_job/my-connector-sync-job" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"
```

#### Java

```java
client.connector().syncJobGet(s -> s
    .connectorSyncJobId("my-connector-sync-job")
);
```

#### PHP

```php
$resp = $client->connector()->syncJobGet([
    "connector_sync_job_id" => "my-connector-sync-job",
]);
```

#### Ruby

```ruby
response = client.connector.sync_job_get(
  connector_sync_job_id: "my-connector-sync-job"
)
```