---
title: "Retrieve a connector"
method: GET
path: "/v1beta/connectors/{connector_id}"
tags: ["Connectors"]
---

# Retrieve a connector

`GET /v1beta/connectors/{connector_id}`

## Request

- Base URL: `https://api.indices.io`
- URL: `https://api.indices.io/v1beta/connectors/{connector_id}`
- Auth: HTTP bearer

Retrieve a connector by its ID.

## Path parameters

- `connector_id` string, required: The ID of the connector to retrieve.

## Response `200`

Successful response

- Connector
  - `id` string, required: Unique identifier for the object.
  - `display_name` string, required: Short human-readable name of the connector.
  - `purpose` string, required: What the connector does, as specified at publish time.
  - `website` string, nullable, required: Website the connector operates against.
  - `input_schema` object, required: JSON Schema for the connector's run arguments.
  - `output_schema` object, required: JSON Schema for the connector's run results.
  - `required_secrets` SecretSlotDefinition[]: Secret slots that must be bound when running the connector.
    - `name` string, required: Name of the secret slot, used as the key in a run's secret_bindings.
    - `type` 'login' | 'string', required
    - `supports_totp` boolean: Whether the connector can perform 2FA/TOTP when the bound login has it configured. Logins without TOTP remain bindable. Only applicable for 'login' type.
    - `description` string, nullable: What the bound secret is used for, when the connector declares it.
  - `version` integer, required: Version of the connector, starting at 1 and incremented by each revision.
  - `created_at` string, date-time, required: Timestamp when the object was created.

## Other responses

- `422`: Validation error

---

[API](https://skmtc.dev/indices/apis/indices-api.md) · [All operations](https://skmtc.dev/indices/apis/indices-api/llms.txt) · [OpenAPI document](https://skmtc.dev/indices/apis/indices-api/revisions/e0f2742c126c?raw)