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

const client = new Openint({
  token: 'My Token',
});

// Automatically fetches more pages as needed.
for await (const listConnectorsResponse of client.listConnectors()) {
  console.log(listConnectorsResponse);
}
{
  "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>"
      },
      "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": [
        {
          "id": "<string>",
          "standard": "<string>",
          "external": "<string>",
          "created_at": "<string>",
          "updated_at": "<string>",
          "connector_name": "accelo",
          "name": "<string>",
          "logo_url": "<string>",
          "stage": "alpha",
          "platforms": [
            "web"
          ],
          "category": "<string>",
          "auth_type": "<string>",
          "version": "<string>"
        }
      ]
    }
  ],
  "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>[]

Response

Successful response

List of connectors

​
items
Connector · object[]
required
​
total
integer
required

Total number of items in the database for the organization

Required range: x >= 0
​
limit
integer
required

Limit the number of items returned

Required range: x >= 0
​
offset
integer
required

Offset the items returned

Required range: x >= 0
​
has_next_page
boolean

Convenience flag = offset + limit >= total