---
type: api
title: Get all connector sync jobs
description: Get information about all stored connector sync jobs listed by their creation date in ascending order.
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-connector-sync-job-list
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v8/operation/operation-connector-sync-job-list
products:
  - Elasticsearch
---

# Get all connector sync jobs

Availability: Beta since 8.12

## Paths

- `GET` `/_connector/_sync_job`

## Description

Get information about all stored connector sync jobs listed by their creation date in ascending order.

## Authentication

- Api key: `Authorization: <value>`
  Elasticsearch APIs support key-based authentication.
  You must create an API key and use the encoded value in the request header.
  For example:
  
  
  ```
  curl -X GET "${ES_URL}/_cat/indices?v=true" \
    -H "Authorization: ApiKey ${API_KEY}"
  ```
  
  To get API keys, use the `/_security/api_key` APIs.
- Basic: `Authorization: Basic <credentials>`
- Bearer: `Authorization: Bearer <token>`
  Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.
  For examples, refer to [Token-based authentication services](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html)

## Query string parameters

- `from` (number · default: 0) — optional
  Starting offset
- `size` (number · default: 100) — optional
  Specifies a max number of results to get
- `status` (enum) — optional
  A sync job status to fetch connector sync jobs for
  Values: `canceling`, `canceled`, `completed`, `error`, `in_progress`, `pending`, `suspended`
- `connector_id` (string) — optional
  A connector id to fetch connector sync jobs for
- `job_type` (union enum | enum[]) — optional
  A comma-separated list of job types to fetch the sync jobs for

Supported values include: `full`, `incremental`, `access_control`
  Values: `full`, `incremental`, `access_control`

## Response

`application/json`

- `count` (number)
- `results` (object[])
  - `cancelation_requested_at` (union)
  - `canceled_at` (union)
  - `completed_at` (union)
  - `connector` (object)
    - `configuration` (object)
    - `filtering` (object)
      - `advanced_snippet` (object)
        - `created_at` (union)
        - `updated_at` (union)
        - `value` (object)
      - `rules` (object[])
        - `created_at` (union)
        - `field` (string)
        - `id` (string)
        - `order` (number)
        - `policy` (enum)
          Values: `exclude`, `include`
        - `rule` (enum)
          Values: `contains`, `ends_with`, `equals`, `regex`, `starts_with`, `>`, `<`
        - `updated_at` (union)
        - `value` (string)
      - `validation` (object)
        - `errors` (object[])
          - `ids` (string[])
          - `messages` (string[])
        - `state` (enum)
          Values: `edited`, `invalid`, `valid`
    - `id` (string)
    - `index_name` (string)
    - `language` (string)
    - `pipeline` (object)
      - `extract_binary_content` (boolean)
      - `name` (string)
      - `reduce_whitespace` (boolean)
      - `run_ml_inference` (boolean)
    - `service_type` (string)
    - `sync_cursor` (object)
  - `created_at` (union)
  - `deleted_document_count` (number)
  - `error` (string)
  - `id` (string)
  - `indexed_document_count` (number)
  - `indexed_document_volume` (number)
  - `job_type` (enum)
    Values: `full`, `incremental`, `access_control`
  - `last_seen` (union)
  - `metadata` (map string to object)
  - `started_at` (union)
  - `status` (enum)
    Values: `canceling`, `canceled`, `completed`, `error`, `in_progress`, `pending`, `suspended`
  - `total_document_count` (number)
  - `trigger_method` (enum)
    Values: `on_demand`, `scheduled`
  - `worker_hostname` (string)
## Code examples

#### Console

```console
GET _connector/_sync_job?connector_id=my-connector-id&size=1
```

#### JavaScript

```javascript
const response = await client.connector.syncJobList({
  connector_id: "my-connector-id",
  size: 1,
});
```

#### Python

```python
resp = client.connector.sync_job_list(
    connector_id="my-connector-id",
    size="1",
)
```

#### curl

```curl
curl -X GET "$ELASTICSEARCH_URL/_connector/_sync_job?connector_id=my-connector-id&size=1" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"
```

#### Java

```java
client.connector().syncJobList(s -> s
    .connectorId("my-connector-id")
    .size(1)
);
```

#### PHP

```php
$resp = $client->connector()->syncJobList([
    "connector_id" => "my-connector-id",
    "size" => "1",
]);
```

#### Ruby

```ruby
response = client.connector.sync_job_list(
  connector_id: "my-connector-id",
  size: "1"
)
```