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

# Get all connectors

Authentication: required

Availability: Beta

## Paths

- `GET` `/_connector`

## Description

Get information about all connectors.

## 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 string | string[]) — optional
  A comma-separated list of connector index names to fetch connector documents for
- `connector_name` (union string | string[]) — optional
  A comma-separated list of connector names to fetch connector documents for
- `service_type` (union string | string[]) — optional
  A comma-separated list of connector service types to fetch connector documents for
- `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 oneOf)
          One of: `string` or `number`
        - `updated_at` (union oneOf)
          One of: `string` or `number`
        - `value` (object)
      - `rules` (object[])
        - `created_at` (union oneOf)
          One of: `string` or `number`
        - `field` (string)
        - `id` (string)
        - `order` (number)
        - `policy` (enum)
          Values: `exclude`, `include`
        - `rule` (enum)
          Values: `contains`, `ends_with`, `equals`, `regex`, `starts_with`, `>`, `<`
        - `updated_at` (union oneOf)
          One of: `string` or `number`
        - `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 oneOf)
    One of: `string` or `number`
  - `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 oneOf)
    One of: `string` or `number`
  - `last_indexed_document_count` (number)
  - `last_seen` (union oneOf)
    One of: `string` or `number`
  - `last_sync_error` (string)
  - `last_sync_scheduled_at` (union oneOf)
    One of: `string` or `number`
  - `last_sync_status` (enum)
    Values: `canceling`, `canceled`, `completed`, `error`, `in_progress`, `pending`, `suspended`
  - `last_synced` (union oneOf)
    One of: `string` or `number`
  - `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
```

## Response examples

#### 200

`application/json`

Generated from the API spec. Values are representative. Unions use the first variant; deeply nested or large bodies may omit fields.

```json
{
  "count": 0,
  "results": [
    {
      "api_key_id": "string",
      "api_key_secret_id": "string",
      "configuration": {
        "key": {
          "category": "string",
          "depends_on": [],
          "display": "textbox",
          "label": "string",
          "options": [],
          "order": 0,
          "placeholder": "string",
          "required": false,
          "sensitive": false,
          "tooltip": "string",
          "type": "str",
          "ui_restrictions": [
            "string"
          ],
          "validations": [],
          "value": {}
        }
      },
      "custom_scheduling": {
        "key": {
          "configuration_overrides": {
            "max_crawl_depth": 0,
            "sitemap_discovery_disabled": false
          },
          "enabled": false,
          "interval": "string",
          "name": "string"
        }
      },
      "deleted": false,
      "description": "string",
      "error": "string",
      "features": {
        "document_level_security": {
          "enabled": false
        },
        "incremental_sync": {
          "enabled": false
        },
        "native_connector_api_keys": {
          "enabled": false
        },
        "sync_rules": {
          "advanced": {
            "enabled": false
          },
          "basic": {
            "enabled": false
          }
        }
      },
      "filtering": [
        {
          "active": {},
          "domain": "string",
          "draft": {}
        }
      ],
      "id": "string",
      "index_name": "string",
      "is_native": false,
      "language": "string",
      "last_access_control_sync_error": "string",
      "last_access_control_sync_scheduled_at": "string",
      "last_access_control_sync_status": "canceling",
      "last_deleted_document_count": 0,
      "last_incremental_sync_scheduled_at": "string",
      "last_indexed_document_count": 0,
      "last_seen": "string",
      "last_sync_error": "string",
      "last_sync_scheduled_at": "string",
      "last_sync_status": "canceling",
      "last_synced": "string",
      "name": "string",
      "pipeline": {
        "extract_binary_content": false,
        "name": "string",
        "reduce_whitespace": false,
        "run_ml_inference": false
      },
      "scheduling": {
        "access_control": {
          "enabled": false,
          "interval": "string"
        },
        "full": {
          "enabled": false,
          "interval": "string"
        },
        "incremental": {
          "enabled": false,
          "interval": "string"
        }
      },
      "service_type": "string",
      "status": "created",
      "sync_cursor": {},
      "sync_now": false
    }
  ]
}
```