Skip to main content

​
List Installed Integrations

Retrieve all integrations installed in your environment. 
curl 'https://api.usehandled.io/api/v1/ipaas/environment-integration' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

​
Response

{
  "result": [
    {
      "id": "int_123",
      "integration": {
        "name": "shiphero",
        "label": "ShipHero",
        "category": "wms"
      },
      "is_enabled": true,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "next_cursor": null
}

​
Get Integration

Retrieve a specific installed integration. 
curl 'https://api.usehandled.io/api/v1/ipaas/environment-integration/{integration_id}' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

​
Update Integration Settings

Modify integration configuration like OAuth credentials or RapidForm settings. 
curl -X PATCH 'https://api.usehandled.io/api/v1/ipaas/environment-integration/{integration_id}' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "override": {
      "oauth": {
        "client_id": "your-client-id",
        "client_secret": "your-client-secret",
        "scopes": ["read", "write"]
      }
    }
  }'

​
Enable/Disable Integration

curl -X PATCH 'https://api.usehandled.io/api/v1/ipaas/environment-integration/{integration_id}' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": false
  }'

​
Filter by Integration Name

curl 'https://api.usehandled.io/api/v1/ipaas/environment-integration?integration.name=shiphero' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'