Skip to Content
API ReferenceBridge Types

Bridge Types

Browse the catalog of available bridge types. Bridge types are registered by deploying bridges via the CLI and define the integration’s manifest, category, required config fields, and supported tasks.

List Bridge Types

GET/api/bridge-types

List all available bridge types in the catalog.

Requiredbridges:read

Returns all bridge types available to the organization. Each entry includes the type’s manifest with metadata, category, supported tasks, and required configuration fields.

Query Parameters

ParameterTypeDescription
pagenumberPage number (default: 1)
limitnumberItems per page (default: 20, max: 100)
categorystringFilter by category: ecommerce, shipping, marketplace, erp
curl -X GET "https://api.orderly.dev/api/bridge-types?category=shipping" \
  -H "Authorization: Bearer ord_sk_..."

Response

{
  "data": [
    {
      "id": "uuid",
      "name": "Shopify",
      "slug": "shopify",
      "description": "Sync orders from Shopify stores",
      "category": "ecommerce",
      "icon_url": "https://...",
      "auth_methods": ["api_key"],
      "config_fields": [
        { "key": "shop_domain", "label": "Shop Domain", "type": "text", "required": true },
        { "key": "api_key", "label": "API Key", "type": "password", "required": true }
      ],
      "tasks": ["grab-orders", "get-order", "push-fulfillment"],
      "created_at": "2026-01-01T00:00:00Z"
    }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 8, "totalPages": 1, "hasMore": false }
}

Get Bridge Type

GET/api/bridge-types/:id

Retrieve a single bridge type by ID.

Requiredbridges:read

Returns the full bridge type definition including all manifest fields, configuration schema, and supported tasks.

curl -X GET "https://api.orderly.dev/api/bridge-types/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer ord_sk_..."
BridgesOperations