Skip to main content
GET
/
connections
List all connections
curl --request GET \
  --url https://api.getmembrane.com/connections \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "userId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "tenantId": "<string>",
      "key": "<string>",
      "isTest": true,
      "connected": true,
      "disconnected": true,
      "isDefunct": true,
      "state": "BUILDING",
      "errors": [
        {
          "message": "<string>",
          "type": "bad_request",
          "key": "<string>",
          "data": {},
          "stack": {},
          "causedByError": "<unknown>",
          "logs": [
            {}
          ]
        }
      ],
      "requestError": {
        "message": "<string>",
        "type": "bad_request",
        "key": "<string>",
        "data": {},
        "stack": {},
        "causedByError": "<unknown>",
        "logs": [
          {}
        ]
      },
      "error": {
        "message": "<string>",
        "type": "bad_request",
        "key": "<string>",
        "data": {},
        "stack": {},
        "causedByError": "<unknown>",
        "logs": [
          {}
        ]
      },
      "integrationId": "<string>",
      "connectorId": "<string>",
      "externalAppId": "<string>",
      "connectorVersion": "<string>",
      "authOptionKey": "<string>",
      "lastActiveAt": "<string>",
      "nextCredentialsRefreshAt": "<string>",
      "nextRetryTimestamp": "<string>",
      "retryAttempts": 123,
      "canTest": true,
      "canRefreshCredentials": true,
      "archivedAt": "<string>",
      "isDeactivated": true,
      "meta": {},
      "buildingAgentSessionId": "<string>",
      "clientAction": {
        "type": "connect",
        "description": "<string>",
        "uiUrl": "<string>",
        "agentInstructions": "<string>"
      },
      "user": {
        "id": "<string>",
        "name": "<string>",
        "internalId": "<string>",
        "meta": {},
        "fields": {},
        "credentials": {},
        "lastActiveAt": "<string>",
        "isTest": true,
        "isBillable": true,
        "isActive": true,
        "aiCreditsRolling30DayLimit": 1,
        "createdAt": "<string>",
        "archivedAt": "<string>"
      },
      "integration": {
        "id": "<string>",
        "name": "<string>",
        "logoUri": "<string>",
        "uuid": "<string>",
        "key": "<string>",
        "description": "<string>",
        "meta": {},
        "state": "BUILDING",
        "errors": [
          {
            "message": "<string>",
            "type": "bad_request",
            "key": "<string>",
            "data": {},
            "stack": {},
            "causedByError": "<unknown>",
            "logs": [
              {}
            ]
          }
        ],
        "revision": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "archivedAt": "<string>",
        "isDeactivated": true,
        "isReadOnly": true,
        "connectorId": "<string>",
        "connectorVersion": "<string>",
        "oAuthCallbackUri": "<string>",
        "parameters": {},
        "hasMissingParameters": true,
        "hasDocumentation": true,
        "hasOperations": true,
        "operationsCount": 123,
        "hasData": true,
        "dataCollectionsCount": 123,
        "hasEvents": true,
        "eventsCount": 123,
        "hasGlobalWebhooks": true,
        "hasUdm": true,
        "isTest": true,
        "externalAppId": "<string>",
        "authType": "integration-app-token",
        "optionsConfig": {}
      },
      "credentials": {},
      "input": {},
      "connectorParameters": {}
    }
  ],
  "cursor": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer

Maximum number of items to return (1-1000)

Required range: 1 <= x <= 1000
cursor
string

Pagination cursor from a previous response

Text search query to filter results

includeArchived
boolean
tenantId
string
integrationId
string

Filter by integration ID

connectorId
string

Filter by connector ID

externalAppId
string
connected
boolean
disconnected
boolean

[DEPRECATED] Use connected instead.

isTest
boolean
userId
string
connectorVersion
string
integrationKey
string
includeSecrets
boolean

Response

200 - application/json
items
object[]
required
cursor
string