Get Connector Provider

curl 'https://api.hydradb.com/connectors/providers?id=affinity' \
  -H "Authorization: Bearer $HYDRA_DB_API_KEY" \
  -H "API-Version: 2"

{
  "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" }
  }
}

GET

connectors

providers

curl 'https://api.hydradb.com/connectors/providers?id=affinity' \
  -H "Authorization: Bearer $HYDRA_DB_API_KEY" \
  -H "API-Version: 2"

{
  "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" }
  }
}

Call GET /connectors/providers?id={provider} with a provider identifier returned by List Connector Providers.

curl 'https://api.hydradb.com/connectors/providers?id=affinity' \
  -H "Authorization: Bearer $HYDRA_DB_API_KEY" \
  -H "API-Version: 2"

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

{
  "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" }
  }
}

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.

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

Filtering by a provider field

{
  "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.

Query Parameters

string

Provider name (e.g. slack, gmail). Omit to list all.

Example:

"HydraDoc1234"

Response

{key}

any

Connectors - Overview List Connector Providers

⌘I

API Documentation

Databases

Context

Query

Connectors

Miscellaneous

Get Connector Provider

Query Parameters

Response

​Related Resources

Query Parameters

Response

Related Resources