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

# Retrieve a connector

> <p>Retrieve a connector by its ID.</p>



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/indices/openapi.documented.yml get /v1beta/connectors/{connector_id}
openapi: 3.1.0
info:
  title: Indices API
  description: 'The Indices REST API. See docs for details: https://docs.indices.io'
  version: 0.0.1
servers:
  - url: https://api.indices.io
security:
  - ApiKeyAuth: []
tags:
  - name: Capture Sessions
    description: >-
      Record a browser session; a completed capture is a reusable input for
      building connectors.
  - name: Connectors
    description: Manage connectors.
  - name: Runs
    description: Execute a connector.
  - name: Secrets
    description: Manage secrets like login credentials and API keys.
paths:
  /v1beta/connectors/{connector_id}:
    get:
      tags:
        - Connectors
      summary: Retrieve a connector
      description: <p>Retrieve a connector by its ID.</p>
      operationId: retrieveConnector
      parameters:
        - name: connector_id
          in: path
          required: true
          schema:
            type: string
            description: The ID of the connector to retrieve.
            title: Connector Id
          description: The ID of the connector to retrieve.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connector'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Indices from 'indicesio';


            const client = new Indices({
              apiKey: process.env['INDICES_API_KEY'], // This is the default and can be omitted
            });


            const connector = await
            client.beta.connectors.retrieve('connector_id');


            console.log(connector.id);
        - lang: Python
          source: |-
            import os
            from indices import Indices

            client = Indices(
                api_key=os.environ.get("INDICES_API_KEY"),  # This is the default and can be omitted
            )
            connector = client.beta.connectors.retrieve(
                "connector_id",
            )
            print(connector.id)
components:
  schemas:
    Connector:
      properties:
        id:
          type: string
          description: Unique identifier for the object.
          examples:
            - conn_8kPq2mWxYz1aBcDeFgHi3J
          example: conn_8kPq2mWxYz1aBcDeFgHi3J
        display_name:
          type: string
          description: Short human-readable name of the connector.
          examples:
            - Invoice retrieval
          example: Invoice retrieval
        purpose:
          type: string
          description: What the connector does, as specified at publish time.
          examples:
            - Retrieve invoices from our ERP system, including refunds.
          example: Retrieve invoices from our ERP system, including refunds.
        website:
          anyOf:
            - type: string
            - type: 'null'
          description: Website the connector operates against.
          examples:
            - https://example.com
          example: https://example.com
        input_schema:
          additionalProperties: true
          type: object
          description: JSON Schema for the connector's run arguments.
        output_schema:
          additionalProperties: true
          type: object
          description: JSON Schema for the connector's run results.
        required_secrets:
          items:
            $ref: '#/components/schemas/SecretSlotDefinition'
          type: array
          description: Secret slots that must be bound when running the connector.
        revised_from_connector_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Connector this one revised (if any).
        created_at:
          type: string
          format: date-time
          description: Timestamp when the object was created.
      type: object
      required:
        - id
        - display_name
        - purpose
        - website
        - input_schema
        - output_schema
        - revised_from_connector_id
        - created_at
      title: Connector
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SecretSlotDefinition:
      properties:
        name:
          type: string
          description: Name of the secret slot, used as the key in a run's secret_bindings.
          examples:
            - amazon_login
          example: amazon_login
        type:
          $ref: '#/components/schemas/SecretType'
          description: 'Type of secret required: ''login'' or ''string''.'
          examples:
            - login
          example: login
        supports_totp:
          type: boolean
          description: >-
            Whether the connector can perform 2FA/TOTP when the bound login has
            it configured. Logins without TOTP remain bindable. Only applicable
            for 'login' type.
          default: false
          examples:
            - false
          example: false
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: What the bound secret is used for, when the connector declares it.
          examples:
            - Amazon account whose orders are fetched.
          example: Amazon account whose orders are fetched.
      type: object
      required:
        - name
        - type
      title: SecretSlotDefinition
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SecretType:
      type: string
      enum:
        - login
        - string
      title: SecretType
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Enter your API key as the bearer token. Set header: `Authorization` to
        `Bearer <api_key>`

````