> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hydradb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Connector Provider

> Get a connector provider's indexed fields, query filters, and credential requirements.

Call `GET /connectors/providers?id={provider}` with a `provider` identifier returned by [List Connector Providers](/api-reference/v2/endpoint/list-connector-providers).

<RequestExample>
  ```bash cURL theme={"dark"}
  curl 'https://api.hydradb.com/connectors/providers?id=affinity' \
    -H "Authorization: Bearer $HYDRA_DB_API_KEY" \
    -H "API-Version: 2"
  ```
</RequestExample>

The response identifies the provider's indexed streams, searchable values, exact-match filters, and credential JSON Schema.

<ResponseExample>
  ```json 200 theme={"dark"}
  {
    "provider": "affinity",
    "connector_type": "affinity",
    "indexed_object_types": ["list_entries", "notes"],
    "searchable_fields": [
      {
        "name": "author",
        "data_type": "string",
        "description": "Resolved name of the note's creator."
      }
    ],
    "filterable_fields": [
      {
        "name": "container_id",
        "data_type": "string",
        "filter_key": "additional_metadata.container_id",
        "description": "Affinity list ID the record belongs to."
      }
    ],
    "credential_schema": {
      "type": "object",
      "properties": { "...": "JSON Schema for the provider's credential inputs" }
    }
  }
  ```
</ResponseExample>

| Property               | Meaning                                                                                                   |
| ---------------------- | --------------------------------------------------------------------------------------------------------- |
| `indexed_object_types` | Provider streams whose records become searchable documents.                                               |
| `searchable_fields`    | Values rendered into the indexed document text. They are searchable, but cannot be targeted individually. |
| `filterable_fields`    | Exact-match filter definitions. Use each entry's `filter_key` in a query's `metadata_filters`.            |
| `credential_schema`    | JSON Schema for the credentials required to connect. Omitted when unavailable.                            |

Each `searchable_fields` and `filterable_fields` entry includes `name`, `data_type`, and an optional `description`; filterable entries also include `filter_key`.

<Note>
  Search queries run over the combined indexed document text. To target a specific field, use a value from `filterable_fields` with `metadata_filters`.
</Note>

```json Filtering by a provider field theme={"dark"}
{
  "database": "acme_corp",
  "query": "diligence notes",
  "query_apps": true,
  "metadata_filters": {
    "additional_metadata": { "container_id": "12345" }
  }
}
```

For Gmail, use `account_email` (`additional_metadata.account_email`) rather than `provider_account_scope` to scope results to a connected account.

## Related Resources

* [List Connector Providers](/api-reference/v2/endpoint/list-connector-providers)
* [Create Connector](/api-reference/v2/endpoint/create-connector)


## OpenAPI

````yaml api-reference/v2/openapi.json GET /connectors/providers
openapi: 3.1.0
info:
  contact:
    email: support@hydradb.com
    name: HydraDB Support
  description: >-
    HydraDB Application API — knowledge ingestion, search, and memory
    management.
  license:
    name: Proprietary
  title: HydraDB Application API
  version: 0.1.0
servers:
  - description: Production server
    url: https://api.hydradb.com
security: []
externalDocs:
  description: ''
  url: ''
paths:
  /connectors/providers:
    get:
      tags:
        - connectors
      summary: List supported providers, or describe one in detail
      description: >-
        Without ?id: returns every supported connector with its availability,
        maturity, category, and sync engine (the connector catalog). With
        ?id=<provider>: returns what that provider stores and how to use it —
        indexed_object_types (the streams that become searchable documents),
        searchable_fields (rendered into the indexed text), filterable_fields
        (each with the exact filter_key to pass in a query's metadata_filters),
        the credential_schema for connecting it, and setup_guide (present for
        providers whose configuration goes beyond the credential schema — e.g.
        bigquery's per-table cursor/change-history settings and the one-time
        ALTER statement they may require).
      parameters:
        - description: Provider name (e.g. slack, gmail). Omit to list all.
          in: query
          name: id
          schema:
            example: HydraDoc1234
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: {}
                type: object
          description: OK
        '404':
          content:
            application/json:
              schema:
                additionalProperties: {}
                type: object
          description: Not Found

````