GET
/
connection
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() {
  // Automatically fetches more pages as needed.
  for await (const listConnectionsResponse of client.listConnections()) {
    console.log(listConnectionsResponse);
  }
}

main();
{
  "items": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "connector_config_id": "<string>",
      "integration_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "display_name": "<string>",
      "disabled": true,
      "metadata": {},
      "connector_name": "<string>",
      "settings": {
        "oauth": {
          "credentials": {
            "access_token": "<string>",
            "client_id": "<string>",
            "scope": "<string>",
            "refresh_token": "<string>",
            "expires_in": 123,
            "expires_at": "<string>",
            "token_type": "<string>",
            "raw": {}
          },
          "created_at": "<string>",
          "updated_at": "<string>",
          "last_fetched_at": "<string>",
          "metadata": {}
        }
      },
      "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>"
        },
        "authType": "BASIC",
        "openint_scopes": [
          "<string>"
        ],
        "scopes": [
          {
            "scope": "<string>",
            "display_name": "<string>",
            "description": "<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

​
limit
integer
Required range: 0 <= x <= 100
​
offset
integer
Required range: x >= 0
​
connector_name
enum<string>
Available options:
aircall,
airtable,
apollo,
brex,
coda,
confluence,
discord,
dummy-oauth2,
facebook,
finch,
firebase,
foreceipt,
github,
gong,
googlecalendar,
googledocs,
googledrive,
googlemail,
googlesheet,
greenhouse,
heron,
hubspot,
instagram,
intercom,
jira,
kustomer,
lever,
linear,
linkedin,
lunchmoney,
mercury,
merge,
microsoft,
moota,
notion,
onebrick,
outreach,
pipedrive,
plaid,
postgres,
quickbooks,
ramp,
reddit,
salesforce,
salesloft,
saltedge,
sharepointonline,
slack,
splitwise,
stripe,
teller,
toggl,
twenty,
twitter,
venmo,
wise,
xero,
yodlee,
zohodesk
​
customer_id
string

The id of the customer in your application. Ensure it is unique for that customer.

​
connector_config_id
string

The id of the connector config, starts with ccfg_

​
include_secrets
enum<string>
default:none

Controls secret inclusion: none (default), basic (auth only), or all secrets

Available options:
none,
basic,
all
​
expand
enum<string>[]

Fields to expand: connector (includes connector details)

Available options:
connector

Response

200
application/json
Successful response

The list of connections

​
items
object[]
required

The connection details

​
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