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

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

async function main() {
  const response = await client.listConnectors();

  console.log(response.items);
}

main();
{
  "items": [
    {
      "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>"
      },
      "authType": "BASIC",
      "openint_scopes": [
        "<string>"
      ],
      "scopes": [
        {
          "scope": "<string>",
          "display_name": "<string>",
          "description": "<string>"
        }
      ],
      "integrations": [
        {
          "id": "<string>",
          "standard": "<string>",
          "external": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "connector_name": "aircall",
          "name": "<string>",
          "logo_url": "<string>",
          "stage": "alpha",
          "platforms": [
            "web"
          ],
          "category": "<string>",
          "auth_type": "<string>",
          "version": "<string>"
        }
      ]
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

Authorizations

​
Authorization
string
header
required

Organization API key generated in the OpenInt Console and passed in the authorization header with format: Bearer {apiKey}

Query Parameters

​
expand
enum<string>[]
Available options:
schemas

Response

200
application/json
Successful response

List of connectors

​
items
object[]
required
​
total
integer
required

Total number of items in the database for the organization

Required range: x >= 0
​
limit
integer
default:50
required

Limit the number of items returned

Required range: 0 <= x <= 100
​
offset
integer
default:0
required

Offset the items returned

Required range: x >= 0