GET
/
core
/
connection
curl --request GET \
  --url https://api.openint.dev/v0/core/connection \
  --header 'x-apikey: <api-key>' \
  --header 'x-connection-id: <api-key>'
[
  {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "id": "<string>",
    "connectorName": "<string>",
    "displayName": "<string>",
    "customerId": "<string>",
    "connectorConfigId": "<string>",
    "integrationId": "<string>",
    "settings": {},
    "standard": {
      "displayName": "<string>",
      "status": "healthy",
      "statusMessage": "<string>",
      "labels": [
        "<string>"
      ]
    },
    "disabled": true,
    "metadata": "<any>",
    "integration": {
      "id": "<string>",
      "name": "<string>",
      "logoUrl": "<string>"
    },
    "connector": {
      "id": "<string>",
      "name": "<string>",
      "logoUrl": "<string>"
    }
  }
]

Authorizations

​
x-apikey
string
header
required
​
x-connection-id
string
header
required

Query Parameters

​
limit
number
​
offset
number
​
customerId
string | null
Minimum length: 1
​
connectorConfigId
string | null

Must start with 'ccfg_'

​
connectorName
string | null
​
forceRefresh
boolean
​
expand
string

Response

200
application/json
Successful response
​
createdAt
string
required
​
updatedAt
string
required
​
id
string
required

Must start with 'conn_'

​
connectorName
string
required

Unique name of the connector

​
connectorConfigId
string
required

Must start with 'ccfg_'

​
displayName
string | null
​
customerId
string | null
Minimum length: 1
​
integrationId
string | null

Must start with 'int_'

​
settings
object | null
​
standard
object | null
​
disabled
boolean
​
metadata
any

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

​
integration
object | null
​
connector
object | null
Previous
Create connection
Next