GET
/
connector-config
import Openint from '@openint/sdk';

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

async function main() {
  // Automatically fetches more pages as needed.
  for await (const listConnectionConfigsResponse of client.listConnectionConfigs()) {
    console.log(listConnectionConfigsResponse);
  }
}

main();
{
  "items": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "org_id": "<string>",
      "display_name": "<string>",
      "disabled": true,
      "metadata": {},
      "connector_name": "<string>",
      "config": {
        "oauth": {
          "client_id": "<string>",
          "client_secret": "<string>",
          "scopes": [
            "<string>"
          ],
          "redirect_uri": "<string>"
        }
      },
      "connector": {
        "name": "<string>",
        "display_name": "<string>",
        "logo_url": "<string>",
        "stage": "alpha",
        "platforms": [
          "web"
        ],
        "schemas": {
          "connector_config": "<any>",
          "connection_settings": "<any>",
          "integration_data": "<any>",
          "webhook_input": "<any>",
          "pre_connect_input": "<any>",
          "connect_input": "<any>",
          "connect_output": "<any>"
        },
        "auth_type": "BASIC",
        "required_scopes": [
          "<string>"
        ],
        "openint_default_scopes": [
          "<string>"
        ],
        "openint_allowed_scopes": [
          "<string>"
        ],
        "scopes": [
          {
            "scope": "<string>",
            "display_name": "<string>",
            "description": "<string>"
          }
        ],
        "has_openint_credentials": true
      },
      "integrations": {},
      "connection_count": 123
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1,
  "has_next_page": true
}

Authorizations

​
Authorization
string
header
required

Organization API Key available in the settings page of the OpenInt Console or Customer API Key or Token Customer authentication token created using the create customer token API. It is passed in the authorization header with format: Bearer {token}

Query Parameters

​
limit
integer
default:50

Limit the number of items returned

Required range: 0 <= x <= 3000
​
offset
integer
default:0

Offset the items returned

Required range: x >= 0
​
expand
enum<string>[]
​
connector_names
enum<string>[]
​
search_query
string | null

Response

200
application/json

Successful response

The list of connector configurations