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

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

// Automatically fetches more pages as needed.
for await (const listConnectionsResponse of client.listConnections()) {
  console.log(listConnectionsResponse);
}
{
  "items": [
    {
      "id": "<string>",
      "customer_id": "<string>",
      "connector_config_id": "<string>",
      "integration_id": "<string>",
      "status_message": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "display_name": "<string>",
      "disabled": true,
      "status": "healthy",
      "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>"
        },
        "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
      },
      "integration": {
        "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
​
connector_names
enum<string>[]
​
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
boolean
​
expand
enum<string>[]

Expand the response with additional optionals

​
search_query
string
​
refresh_policy
enum<string>
default:none

Controls credential refresh: none (never), force (always), or auto (when expired, default)

Available options:
none,
force,
auto

Response

Successful response

The list of connections

​
items
(accelo · object | acme-apikey · object | acme-oauth2 · object | adobe · object | adyen · object | aircall · object | amazon · object | apaleo · object | asana · object | attio · object | auth0 · object | autodesk · object | aws · object | bamboohr · object | basecamp · object | battlenet · object | bigcommerce · object | bitbucket · object | bitly · object | blackbaud · object | boldsign · object | box · object | braintree · object | calendly · object | clickup · object | close · object | confluence · object | contentful · object | contentstack · object | copper · object | coros · object | datev · object | deel · object | dialpad · object | digitalocean · object | discord · object | docusign · object | dropbox · object | ebay · object | egnyte · object | envoy · object | eventbrite · object | exist · object | facebook · object | factorial · object | figma · object | fitbit · object | fortnox · object | freshbooks · object | front · object | github · object | gitlab · object | gong · object | google-calendar · object | google-docs · object | google-drive · object | google-mail · object | google-sheet · object | gorgias · object | grain · object | gumroad · object | gusto · object | harvest · object | highlevel · object | hubspot · object | instagram · object | intercom · object | jira · object | keap · object | lever · object | linear · object | linkedin · object | linkhut · object | mailchimp · object | miro · object | monday · object | mural · object | namely · object | nationbuilder · object | netsuite · object | notion · object | odoo · object | okta · object | osu · object | oura · object | outreach · object | pagerduty · object | pandadoc · object | payfit · object | paypal · object | pennylane · object | pinterest · object | pipedrive · object | podium · object | productboard · object | qualtrics · object | quickbooks · object | reddit · object | sage · object | salesforce · object | salesloft · object | segment · object | servicem8 · object | servicenow · object | sharepoint · object | shopify · object | signnow · object | slack · object | smartsheet · object | snowflake · object | spotify · object | squarespace · object | squareup · object | stackexchange · object | strava · object | teamwork · object | ticktick · object | timely · object | todoist · object | tremendous · object | tsheetsteam · object | tumblr · object | twinfield · object | twitch · object | twitter · object | typeform · object | uber · object | vimeo · object | wakatime · object | wealthbox · object | webflow · object | whoop · object | wordpress · object | wrike · object | xero · object | yahoo · object | yandex · object | zapier · object | zendesk · object | zenefits · object | zoho-desk · object | zoho · object | zoom · object | airtable · object | apollo · object | brex · object | coda · object | finch · object | firebase · object | foreceipt · object | greenhouse · object | heron · object | lunchmoney · object | mercury · object | merge · object | moota · object | onebrick · object | openledger · object | plaid · object | postgres · object | ramp · object | saltedge · object | sharepoint-onprem · object | splitwise · object | stripe · object | teller · object | toggl · object | twenty · object | venmo · object | wise · object | yodlee · 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