Skip to main content

Get Integrations List

GET /v1/integration/instance

Retrieves a list of available integrations. Each integration item provides information about its configuration, status, available actions, and related resources. This endpoint helps identify integrations that are active and ready for use.

Response Example​

[
  {
    "_id": "integration-id-1",
    "id": "integration-id-1",
    "status": {
      "enabled": true,
      "connected": true
    },
    "actions": [
      "account:list",
      "user:list",
      "order:list",
      "product:list"
    ],
    "configuration": [],
    "description": "Import data from comma-separated values. Templates are provided to facilitate the import process.",
    "logo": "https://api.example.com/v1/files/public/icons/csv.png",
    "examples": {
      "importAccounts": "https://api.example.com/v1/files/public/examples/csv/import-accounts.csv",
      "importUsers": "https://api.example.com/v1/files/public/examples/csv/import-users.csv",
      "importOrders": "https://api.example.com/v1/files/public/examples/csv/import-orders.csv"
    },
    "name": "Comma-Separated Values (CSV)",
    "provider": "csv",
    "tenant": "",
    "type": "",
    "workers": [],
    "instanceId": "instance-id-1",
    "version": 1
  }
]