Connectors

List connectors

List the connectors in your catalog.

get/v1beta/connectors

Request

  • Base URL: https://api.indices.io
  • URL: https://api.indices.io/v1beta/connectors
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of connectors to return.

cursorstring

Cursor from a previous response's next_cursor, to fetch the next page.

domainstring

Only connectors whose website is this domain or a subdomain of it.

Response

Successful response

has_moreboolean required

Whether more connectors exist after this page.

next_cursorstring nullable required

Pass as the cursor query parameter to fetch the next page. Null when has_more is false.

Example response

{
  "data": [
    {
      "id": "conn_8kPq2mWxYz1aBcDeFgHi3J",
      "display_name": "Invoice retrieval",
      "purpose": "Retrieve invoices from our ERP system, including refunds.",
      "website": "https://example.com",
      "required_secrets": [
        {
          "name": "amazon_login",
          "description": "Amazon account whose orders are fetched."
        }
      ],
      "version": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.