---
updatedAt: 2026-04-21T21:33:14.000Z
agentTools:
  projectIndex: https://docs.oneschema.co/llms.txt
---

# Get a Multi FileFeed

Retrieves a single Multi FileFeed by ID, including its source and destination connections, and attached event webhooks.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Multi FileFeeds",
    "version": "0.0.1",
    "description": "API for managing Multi FileFeeds in OneSchema.\n\nNOTE: Multi FileFeed import endpoints are served under the `/v0/multi-file-feeds/`\npath prefix. The legacy `/v0/workflows/` prefix is still supported for backward\ncompatibility but is deprecated and may be removed in a future version.\n",
    "contact": {
      "name": "OneSchema Support",
      "email": "support@oneschema.co"
    },
    "license": {
      "name": "proprietary",
      "url": "https://www.oneschema.co/terms-and-conditions"
    },
    "termsOfService": "https://www.oneschema.co/terms-and-conditions"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://api.oneschema.co",
      "description": "Production server (hosted in the US)"
    },
    {
      "url": "https://api.eu.oneschema.co",
      "description": "Production server (hosted in the EU)"
    },
    {
      "url": "https://api.ca.oneschema.co",
      "description": "Production server (hosted in Canada)"
    },
    {
      "url": "https://api.au.oneschema.co",
      "description": "Production server (hosted in Australia)"
    }
  ],
  "tags": [
    {
      "name": "Multi FileFeeds",
      "description": "Multi FileFeed operations"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    },
    "schemas": {
      "MultiFileFeedTemplate": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "is_required": {
            "type": "boolean",
            "description": "Whether this template is required for the Multi FileFeed"
          }
        }
      },
      "SourceSftp": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "sftp"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "sftp_account_id": {
                "type": "integer"
              },
              "path": {
                "type": "string",
                "format": "path"
              },
              "options": {
                "type": "object",
                "properties": {
                  "schedule": {
                    "type": "object",
                    "properties": {
                      "frequency": {
                        "type": "string",
                        "enum": [
                          "hourly",
                          "daily"
                        ]
                      },
                      "hour_utc": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 23,
                        "description": "Hour in UTC for daily frequency"
                      },
                      "minute_utc": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 55,
                        "multipleOf": 5,
                        "description": "Minute offset within the hour (must be a multiple of 5, 0-55). Defaults to 0 (top of the hour)."
                      }
                    }
                  }
                }
              }
            },
            "required": [
              "sftp_account_id",
              "path"
            ]
          }
        }
      },
      "SourceS3": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "s3"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "s3_account_id": {
                "type": "integer"
              },
              "bucket": {
                "type": "string"
              },
              "prefix": {
                "type": "string",
                "nullable": true,
                "description": "Key prefix within the bucket to scope listing/pulling to. Defaults to empty (whole bucket)."
              },
              "file_filter": {
                "type": "string",
                "nullable": true,
                "description": "Optional regular expression applied to object keys. When set, only matching keys are ingested.\nNote: changing `file_filter` does not retroactively re-ingest objects that already passed the\ncursor watermark; only newly listed objects are evaluated against the new pattern. Changing\n`bucket` or `prefix`, by contrast, resets the cursor and dedupe ledger because they reference\na different object namespace.\n"
              },
              "options": {
                "type": "object",
                "properties": {
                  "schedule": {
                    "type": "object",
                    "properties": {
                      "frequency": {
                        "type": "string",
                        "enum": [
                          "hourly",
                          "daily"
                        ]
                      },
                      "hour_utc": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 23,
                        "description": "Hour in UTC for daily frequency"
                      },
                      "minute_utc": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 55,
                        "multipleOf": 5,
                        "description": "Minute offset within the hour (must be a multiple of 5, 0-55). Defaults to 0 (top of the hour)."
                      }
                    }
                  }
                }
              }
            },
            "required": [
              "s3_account_id",
              "bucket"
            ]
          }
        }
      },
      "DestinationSftp": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "sftp"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "sftp_account_id": {
                "type": "integer"
              },
              "path": {
                "type": "string",
                "format": "path"
              }
            },
            "required": [
              "sftp_account_id",
              "path"
            ]
          }
        }
      },
      "DestinationS3": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "s3"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "s3_account_id": {
                "type": "integer"
              },
              "bucket": {
                "type": "string"
              },
              "prefix": {
                "type": "string",
                "nullable": true,
                "description": "Key prefix within the bucket. Output files are written to `{prefix}/{file_name}`. Defaults to empty (write to bucket root)."
              }
            },
            "required": [
              "s3_account_id",
              "bucket"
            ]
          }
        }
      },
      "EventWebhook": {
        "type": "object",
        "properties": {
          "webhook_key": {
            "type": "string",
            "description": "Unique key identifying the webhook"
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of event types the webhook is subscribed to"
          }
        }
      },
      "MultiFileFeed": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "folder_id": {
            "type": "integer",
            "description": "ID of the folder containing this Multi FileFeed"
          },
          "custom_metadata": {
            "type": "object"
          },
          "templates": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MultiFileFeedTemplate"
            }
          },
          "source": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/SourceSftp"
                },
                {
                  "$ref": "#/components/schemas/SourceS3"
                }
              ]
            }
          },
          "destination": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/DestinationSftp"
                },
                {
                  "$ref": "#/components/schemas/DestinationS3"
                }
              ]
            }
          },
          "sources": {
            "type": "array",
            "description": "Per-environment source connections. Each entry is a source connection with an optional environment_id.",
            "items": {
              "$ref": "#/components/schemas/MultiFileFeedSource"
            }
          },
          "destinations": {
            "type": "array",
            "description": "Per-environment destination connections. Each entry is a destination connection with an optional environment_id.",
            "items": {
              "$ref": "#/components/schemas/MultiFileFeedDestination"
            }
          },
          "event_webhooks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventWebhook"
            }
          }
        }
      },
      "MultiFileFeedSource": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/SourceConnection"
          }
        ],
        "properties": {
          "environment_id": {
            "type": "integer",
            "nullable": true,
            "description": "The environment this source is scoped to. Null for unassigned (legacy default)."
          }
        }
      },
      "MultiFileFeedDestination": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/DestinationConnection"
          }
        ],
        "properties": {
          "environment_id": {
            "type": "integer",
            "nullable": true,
            "description": "The environment this destination is scoped to. Null for unassigned (legacy default)."
          }
        }
      },
      "SourceGcs": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "gcs"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "object_storage_account_id": {
                "type": "integer",
                "description": "ID of the GCS object storage connection account."
              },
              "bucket": {
                "type": "string",
                "description": "GCS bucket name."
              },
              "prefix": {
                "type": "string",
                "nullable": true,
                "description": "Optional prefix/key/folder path to scope objects to. Defaults to empty."
              },
              "file_filter": {
                "type": "string",
                "nullable": true,
                "description": "Optional regular expression applied to object keys."
              },
              "options": {
                "type": "object",
                "nullable": true,
                "additionalProperties": true,
                "description": "Provider-specific configuration. Exact keys depend on the connection type (e.g. schedule, tables, folder details)."
              }
            },
            "required": [
              "object_storage_account_id",
              "bucket"
            ]
          }
        }
      },
      "SourceAzureBlob": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "azure-blob"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "object_storage_account_id": {
                "type": "integer",
                "description": "ID of the Azure Blob object storage connection account."
              },
              "container": {
                "type": "string",
                "description": "Azure Blob container name."
              },
              "prefix": {
                "type": "string",
                "nullable": true,
                "description": "Optional prefix/key/folder path to scope objects to. Defaults to empty."
              },
              "file_filter": {
                "type": "string",
                "nullable": true,
                "description": "Optional regular expression applied to object keys."
              },
              "options": {
                "type": "object",
                "nullable": true,
                "additionalProperties": true,
                "description": "Provider-specific configuration. Exact keys depend on the connection type (e.g. schedule, tables, folder details)."
              }
            },
            "required": [
              "object_storage_account_id",
              "container"
            ]
          }
        }
      },
      "SourceAzureSharepoint": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "azure-sharepoint"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "credential_id": {
                "type": "integer"
              },
              "drive_kind": {
                "type": "string"
              },
              "drive_id": {
                "type": "string"
              },
              "site_id": {
                "type": "string",
                "nullable": true
              },
              "folder_item_id": {
                "type": "string",
                "nullable": true
              },
              "file_filter": {
                "type": "string",
                "nullable": true,
                "description": "Optional regular expression applied to item names."
              },
              "options": {
                "type": "object",
                "nullable": true,
                "additionalProperties": true,
                "description": "Provider-specific configuration. Exact keys depend on the connection type (e.g. schedule, tables, folder details)."
              }
            },
            "required": [
              "credential_id",
              "drive_kind",
              "drive_id"
            ]
          }
        }
      },
      "SourceGoogleDrive": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "google-drive"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "credential_id": {
                "type": "integer"
              },
              "drive_id": {
                "type": "string",
                "description": "ID of the Google Drive to import from."
              },
              "folder_id": {
                "type": "string",
                "description": "ID of the folder within the drive to import from."
              },
              "folder_name": {
                "type": "string",
                "nullable": true,
                "description": "Display name of the folder."
              },
              "include_subfolders": {
                "type": "boolean",
                "nullable": true,
                "description": "Whether to import files from subfolders."
              },
              "subfolders_only": {
                "type": "boolean",
                "nullable": true,
                "description": "Whether to only import files from subfolders."
              },
              "file_filter": {
                "type": "string",
                "nullable": true,
                "description": "Optional regular expression applied to item names."
              },
              "options": {
                "type": "object",
                "nullable": true,
                "additionalProperties": true,
                "description": "Provider-specific configuration. Exact keys depend on the connection type (e.g. schedule, tables, folder details)."
              }
            },
            "required": [
              "credential_id",
              "drive_id",
              "folder_id"
            ]
          }
        }
      },
      "SourceSqlServer": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "sql-server"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "sql_server_account_id": {
                "type": "integer"
              },
              "options": {
                "type": "object",
                "nullable": true,
                "additionalProperties": true,
                "description": "Provider-specific configuration. Exact keys depend on the connection type (e.g. schedule, tables, folder details)."
              }
            },
            "required": [
              "sql_server_account_id"
            ]
          }
        }
      },
      "DestinationGcs": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "gcs"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "object_storage_account_id": {
                "type": "integer",
                "description": "ID of the GCS object storage connection account."
              },
              "bucket": {
                "type": "string",
                "description": "GCS bucket name."
              },
              "prefix": {
                "type": "string",
                "nullable": true,
                "description": "Optional prefix path. Output files are written to {prefix}/{file_name}. Defaults to empty."
              }
            },
            "required": [
              "object_storage_account_id",
              "bucket"
            ]
          }
        }
      },
      "DestinationAzureBlob": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "azure-blob"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "object_storage_account_id": {
                "type": "integer",
                "description": "ID of the Azure Blob object storage connection account."
              },
              "container": {
                "type": "string",
                "description": "Azure Blob container name."
              },
              "prefix": {
                "type": "string",
                "nullable": true,
                "description": "Optional prefix path. Output files are written to {prefix}/{file_name}. Defaults to empty."
              }
            },
            "required": [
              "object_storage_account_id",
              "container"
            ]
          }
        }
      },
      "DestinationAzureSharepoint": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "azure-sharepoint"
            ]
          },
          "data": {
            "type": "object",
            "properties": {
              "credential_id": {
                "type": "integer"
              },
              "drive_kind": {
                "type": "string"
              },
              "drive_id": {
                "type": "string"
              },
              "site_id": {
                "type": "string",
                "nullable": true
              },
              "folder_item_id": {
                "type": "string",
                "nullable": true
              }
            },
            "required": [
              "credential_id",
              "drive_kind",
              "drive_id"
            ]
          }
        }
      },
      "SourceConnection": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/SourceSftp"
          },
          {
            "$ref": "#/components/schemas/SourceS3"
          },
          {
            "$ref": "#/components/schemas/SourceGcs"
          },
          {
            "$ref": "#/components/schemas/SourceAzureBlob"
          },
          {
            "$ref": "#/components/schemas/SourceAzureSharepoint"
          },
          {
            "$ref": "#/components/schemas/SourceGoogleDrive"
          },
          {
            "$ref": "#/components/schemas/SourceSqlServer"
          }
        ]
      },
      "DestinationConnection": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/DestinationSftp"
          },
          {
            "$ref": "#/components/schemas/DestinationS3"
          },
          {
            "$ref": "#/components/schemas/DestinationGcs"
          },
          {
            "$ref": "#/components/schemas/DestinationAzureBlob"
          },
          {
            "$ref": "#/components/schemas/DestinationAzureSharepoint"
          }
        ]
      }
    }
  },
  "paths": {
    "/v0/multi-file-feeds/{multi_file_feed_id}": {
      "parameters": [
        {
          "name": "multi_file_feed_id",
          "in": "path",
          "required": true,
          "schema": {
            "type": "integer"
          },
          "description": "ID of the Multi FileFeed"
        }
      ],
      "get": {
        "summary": "Get a Multi FileFeed",
        "description": "Retrieves a single Multi FileFeed by ID, including its source and destination connections, and attached event webhooks.",
        "operationId": "get-multi-file-feed",
        "tags": [
          "Multi FileFeeds"
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MultiFileFeed"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    }
  }
}
```