---
type: api
title: Get all connectors
description: Get information about all connectors.
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v9/operation/operation-connector-list
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/elasticsearch/v9/operation/operation-connector-list
products:
  - Elasticsearch
---

# Get all connectors

Availability: Beta since 8.12

## Paths

- `GET` `/_connector`

## Description

Get information about all connectors.

## 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/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)

## Query string parameters

- `from` (number · default: 0) — optional
  Starting offset
- `size` (number · default: 100) — optional
  Specifies a max number of results to get
- `index_name` (union oneOf) — optional
  A comma-separated list of connector index names to fetch connector documents for
  One of: `string[]` or `string`
- `connector_name` (union oneOf) — optional
  A comma-separated list of connector names to fetch connector documents for
  One of: `string[]` or `string`
- `service_type` (union oneOf) — optional
  A comma-separated list of connector service types to fetch connector documents for
  One of: `string[]` or `string`
- `include_deleted` (boolean · default: false) — optional
  A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.
- `query` (string) — optional
  A wildcard query string that filters connectors with matching name, description or index name

## Response

`application/json`

- `count` (number)
- `results` (object[])
  - `api_key_id` (string)
  - `api_key_secret_id` (string)
  - `configuration` (object)
  - `custom_scheduling` (object)
  - `deleted` (boolean)
  - `description` (string)
  - `error` (union string) — nullable
    One of: `string`
  - `features` (object)
    - `document_level_security` (object)
      Indicates whether document-level security is enabled.
      - `enabled` (boolean)
    - `incremental_sync` (object)
      Indicates whether incremental syncs are enabled.
      - `enabled` (boolean)
    - `native_connector_api_keys` (object)
      Indicates whether managed connector API keys are enabled.
      - `enabled` (boolean)
    - `sync_rules` (object)
      - `advanced` (object)
        Indicates whether advanced sync rules are enabled.
        - `enabled` (boolean)
      - `basic` (object)
        Indicates whether basic sync rules are enabled.
        - `enabled` (boolean)
  - `filtering` (object[])
    - `active` (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`
    - `domain` (string)
    - `draft` (object)
      Same fields as `active` in `filtering`
  - `id` (string)
  - `index_name` (union string) — nullable
  - `is_native` (boolean)
  - `language` (string)
  - `last_access_control_sync_error` (string)
  - `last_access_control_sync_scheduled_at` (union)
  - `last_access_control_sync_status` (enum)
    Values: `canceling`, `canceled`, `completed`, `error`, `in_progress`, `pending`, `suspended`
  - `last_deleted_document_count` (number)
  - `last_incremental_sync_scheduled_at` (union)
  - `last_indexed_document_count` (number)
  - `last_seen` (union)
  - `last_sync_error` (string)
  - `last_sync_scheduled_at` (union)
  - `last_sync_status` (enum)
    Values: `canceling`, `canceled`, `completed`, `error`, `in_progress`, `pending`, `suspended`
  - `last_synced` (union)
  - `name` (string)
  - `pipeline` (object)
    - `extract_binary_content` (boolean)
    - `name` (string)
    - `reduce_whitespace` (boolean)
    - `run_ml_inference` (boolean)
  - `scheduling` (object)
    - `access_control` (object)
      - `enabled` (boolean)
      - `interval` (string)
        The interval is expressed using the crontab syntax
    - `full` (object)
      - `enabled` (boolean)
      - `interval` (string)
        The interval is expressed using the crontab syntax
    - `incremental` (object)
      - `enabled` (boolean)
      - `interval` (string)
        The interval is expressed using the crontab syntax
  - `service_type` (string)
  - `status` (enum)
    Values: `created`, `needs_configuration`, `configured`, `connected`, `error`
  - `sync_cursor` (object)
  - `sync_now` (boolean)
## Code examples

#### Console

```console
GET _connector
```

#### JavaScript

```javascript
const response = await client.connector.list();
```

#### Python

```python
resp = client.connector.list()
```

#### curl

```curl
curl -X GET "$ELASTICSEARCH_URL/_connector" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"
```

#### Java

```java
client.connector().list(l -> l);
```

#### PHP

```php
$resp = $client->connector()->list();
```

#### Ruby

```ruby
response = client.connector.list
```