Get Integrations

GET /v1/integration

Retrieves a paginated list of integrations available to the tenant. Each item includes status, actions, configuration schema, provider metadata, and UI hints (like logo and notifications). Use this to render an integrations catalog or check current connection state.

Response Example

{
  "metadata": {
    "total": 6,
    "limit": 10
  },
  "data": [
    {
      "_id": "integration-id-1",
      "workerId": "worker-id-1",
      "__v": 1,
      "actions": [
        "account:list",
        "account:export",
        "product:list",
        "order:create",
        "distributor:sync"
      ],
      "configuration": [
        {
          "uuid": "environment",
          "label": "Environment",
          "description": "",
          "type": "select",
          "required": true,
          "related": { "to": "url", "with": "relatedValue" },
          "options": [
            { "label": "Production API", "value": "production", "relatedValue": "https://api.example.com/v1", "disabled": true },
            { "label": "Sandbox API", "value": "sandbox", "relatedValue": "https://sandbox.example.com/v1", "disabled": true },
            { "label": "Custom", "value": "custom", "relatedValue": "", "disabled": false }
          ],
          "isEncrypted": false,
          "defaultValue": "",
          "enabled": true,
          "_id": "config-id-1a"
        },
        {
          "uuid": "url",
          "label": "URL",
          "description": "Base URL to the external API.",
          "type": "textInput",
          "required": true,
          "options": [],
          "isEncrypted": false,
          "defaultValue": "",
          "enabled": true,
          "_id": "config-id-1b"
        },
        {
          "uuid": "api_key",
          "label": "API Key",
          "description": "API key generated in the external system.",
          "type": "passwordInput",
          "required": true,
          "options": [],
          "isEncrypted": true,
          "defaultValue": "",
          "enabled": true,
          "_id": "config-id-1c"
        }
      ],
      "description": "Example external platform integration.",
      "logo": "https://api.example.com/files/public/icons/example.png",
      "name": "Example Platform Integration",
      "provider": "example-platform",
      "status": { "connected": true },
      "tenant": "tenant-id-1",
      "type": "productManagement",
      "notifications": [],
      "version": 1
    },
    {
      "_id": "integration-id-2",
      "workerId": "worker-id-2",
      "__v": 0,
      "actions": [],
      "configuration": [
        {
          "uuid": "authenticate",
          "label": "",
          "description": "",
          "type": "hidden",
          "required": false,
          "options": [],
          "isEncrypted": false,
          "defaultValue": null,
          "enabled": true,
          "_id": "config-id-2a"
        },
        {
          "uuid": "workflowId",
          "label": "Workflow ID",
          "description": "Connect workflow identifier.",
          "type": "hidden",
          "required": true,
          "options": [],
          "isEncrypted": false,
          "defaultValue": null,
          "enabled": true,
          "_id": "config-id-2b"
        },
        {
          "uuid": "isOAuthApp",
          "label": "isOAuthApp",
          "description": "Indicates if the application uses OAuth.",
          "type": "hidden",
          "required": false,
          "options": [],
          "isEncrypted": false,
          "defaultValue": null,
          "enabled": true,
          "_id": "config-id-2c"
        },
        {
          "uuid": "conf_primarySource",
          "label": "Primary Source",
          "description": "Primary source of truth when conflicts occur.",
          "type": "select",
          "required": true,
          "options": [
            { "value": "system-a", "label": "System A" },
            { "value": "zave", "label": "ZaveIT" }
          ],
          "isEncrypted": false,
          "defaultValue": null,
          "enabled": true,
          "_id": "config-id-2d"
        }
      ],
      "description": "Example accounting integration.",
      "logo": "https://logo.clearbit.com/example.com",
      "name": "Accounting Suite Integration",
      "provider": "cma-ACCT-1234",
      "status": { "connected": true },
      "tenant": "tenant-id-1",
      "type": "cma",
      "notifications": [],
      "version": 1
    },
    {
      "_id": "integration-id-3",
      "workerId": "worker-id-3",
      "__v": 1,
      "actions": [
        "product:list",
        "order:create",
        "distributor:sync"
      ],
      "configuration": [
        {
          "uuid": "clientId",
          "label": "Client Id",
          "description": "Client ID from the provider.",
          "type": "textInput",
          "required": true,
          "options": [],
          "isEncrypted": false,
          "defaultValue": null,
          "enabled": true,
          "_id": "config-id-3a"
        },
        {
          "uuid": "clientSecret",
          "label": "Client Secret",
          "description": "Client secret from the provider.",
          "type": "passwordInput",
          "required": true,
          "options": [],
          "isEncrypted": true,
          "defaultValue": null,
          "enabled": true,
          "_id": "config-id-3b"
        },
        {
          "uuid": "workflowId",
          "label": "Workflow ID",
          "description": "Connect workflow identifier.",
          "type": "hidden",
          "required": true,
          "options": [],
          "isEncrypted": false,
          "defaultValue": null,
          "enabled": true,
          "_id": "config-id-3c"
        }
      ],
      "description": "Cloud marketplace integration.",
      "logo": "https://logo.clearbit.com/example-cloud.com",
      "name": "Cloud Marketplace",
      "provider": "cma-CLOUD-5678",
      "status": { "connected": true },
      "tenant": "tenant-id-1",
      "type": "cma",
      "notifications": [
        { "message": "Initial sync may take 20–30 minutes to complete", "level": "warning", "_id": "note-id-1" }
      ],
      "version": 1
    },
    {
      "_id": "integration-id-4",
      "workerId": "worker-id-4",
      "__v": 1,
      "actions": [
        "account:create",
        "order:create",
        "account:list",
        "account:export",
        "product:list"
      ],
      "configuration": [
        {
          "uuid": "env",
          "label": "Environment",
          "description": "",
          "type": "select",
          "required": false,
          "related": { "to": "url", "with": "relatedValue" },
          "options": [
            { "label": "Production", "value": "production", "relatedValue": "https://api.example-erp.com/v2", "disabled": true },
            { "label": "Sandbox", "value": "sandbox", "relatedValue": "https://sandbox.example-erp.com/v2", "disabled": true },
            { "label": "Custom", "value": "custom", "relatedValue": "", "disabled": false }
          ],
          "isEncrypted": false,
          "defaultValue": null,
          "enabled": true,
          "_id": "config-id-4a"
        },
        {
          "uuid": "url",
          "label": "URL",
          "description": "",
          "type": "textInput",
          "required": false,
          "options": [],
          "isEncrypted": false,
          "defaultValue": null,
          "enabled": true,
          "_id": "config-id-4b"
        },
        {
          "uuid": "employeeToken",
          "label": "Employee Token",
          "description": "",
          "type": "passwordInput",
          "required": true,
          "options": [],
          "isEncrypted": true,
          "defaultValue": null,
          "enabled": true,
          "_id": "config-id-4c"
        }
      ],
      "description": "Example ERP integration.",
      "logo": "https://api.example.com/files/public/icons/erp.png",
      "name": "ERP Suite",
      "provider": "erp-suite",
      "status": { "connected": true },
      "tenant": "tenant-id-1",
      "type": "accountant",
      "notifications": [],
      "version": 1
    },
    {
      "_id": "integration-id-5",
      "workerId": "worker-id-5",
      "__v": 1,
      "actions": [],
      "configuration": [
        {
          "uuid": "environment",
          "label": "Environment",
          "description": "",
          "type": "select",
          "required": true,
          "related": { "to": "url", "with": "relatedValue" },
          "options": [
            { "label": "Provider Development", "value": "development", "relatedValue": "https://dev.example-backup.com/api/v3", "disabled": true },
            { "label": "Custom", "value": "custom", "relatedValue": "", "disabled": false }
          ],
          "isEncrypted": false,
          "defaultValue": "",
          "enabled": true,
          "_id": "config-id-5a"
        },
        {
          "uuid": "url",
          "label": "URL",
          "description": "Base URL to Backup REST API (e.g., \"/api/v3\").",
          "type": "textInput",
          "required": true,
          "options": [],
          "isEncrypted": false,
          "defaultValue": "",
          "enabled": true,
          "_id": "config-id-5b"
        },
        {
          "uuid": "api_key",
          "label": "API Key",
          "description": "API key generated in the backup console.",
          "type": "passwordInput",
          "required": true,
          "options": [],
          "isEncrypted": true,
          "defaultValue": "",
          "enabled": true,
          "_id": "config-id-5c"
        }
      ],
      "description": "Backup service provider console integration.",
      "logo": "https://api.example.com/backup/public/provider.png",
      "name": "Backup Service Provider Console",
      "provider": "backup-provider",
      "status": { "connected": true },
      "tenant": "tenant-id-1",
      "type": "backup",
      "notifications": [],
      "version": 1
    }
  ]
}