Get Integration by ID

GET /v1/integration/:id

Retrieves detailed information about a specific integration using its unique identifier. The response includes the current connection status, configuration fields, available actions, and other metadata related to the integration.

Response Example

{
  "status": {
    "connected": true
  },
  "_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": "Example Platform REST API",
          "value": "production",
          "relatedValue": "https://api.example.com/v1",
          "disabled": true
        },
        {
          "label": "Example Platform REST API (Sandbox)",
          "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-1"
    },
    {
      "uuid": "url",
      "label": "URL",
      "description": "URL to Example Platform REST API.",
      "type": "textInput",
      "required": true,
      "options": [],
      "isEncrypted": false,
      "defaultValue": "",
      "enabled": true,
      "_id": "config-id-2"
    },
    {
      "uuid": "api_key",
      "label": "API Key",
      "description": "API Key generated in Example Platform.",
      "type": "passwordInput",
      "required": true,
      "options": [],
      "isEncrypted": true,
      "defaultValue": "",
      "enabled": true,
      "_id": "config-id-3"
    }
  ],
  "description": "Example Platform Integration",
  "logo": "https://api.example.com/v1/files/public/icons/example.png",
  "name": "Example Platform Integration",
  "provider": "exampleProvider",
  "tenant": "",
  "type": "productManagement",
  "notifications": [],
  "version": 1,
  "id": "integration-id-1"
}