GET
/
connection
/
{id}
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.getConnection('conn_');

  console.log(response);
}

main();
{
  "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>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The id of the connection, starts with conn_

Query Parameters

​
include_secrets
enum<string>
default:none

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

Available options:
none,
basic,
all
​
refresh_policy
enum<string>
default:auto

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

Available options:
none,
force,
auto
​
expand
enum<string>[]

Fields to expand: connector (includes connector details)

Available options:
connector

Response

200
application/json
Successful response

The connection details

​
id
string
required
​
customer_id
string | null
required
​
connector_config_id
string
required
​
integration_id
string | null
required
​
created_at
string
required
​
updated_at
string
required
​
display_name
string | null
required
​
disabled
boolean | null
required
​
connector_name
string
required
Allowed value: "dummy-oauth2"
​
settings
object
required
​
metadata
object | null

JSON object can can be used to associate arbitrary metadata to avoid needing a separate 1-1 table just for simple key values in your application. During updates this object will be shallowly merged

​
connector
object