---
title: "List feeds"
method: GET
path: "/v1/feeds"
tags: ["Feeds"]
---

# List feeds

`GET /v1/feeds`

## Request

- Base URL: `https://api.banksync.io`
- URL: `https://api.banksync.io/v1/feeds`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

List feeds owned by the current workspace. Pass `?scope=family` to include feeds from every portal under this workspace. Family scope requires admin+ role and is only valid on a top-level workspace.

## Query parameters

- `scope` 'self' | 'family': Resource scope. `self` (default) returns this workspace only. `family` includes every portal under it; each row gains `workspaceId` + `portal: { id, name, icon } | null`. Admin+ only, top-level workspaces only.

## Response `200`

List of feeds. When `scope=family`, each row additionally carries `workspaceId` and `portal`.

- object
  - `success` true, required
  - `data` object[], required
    - `id` string, required
    - `name` string, required
    - `icon` string
    - `workspaceId` string
    - `source` 'sync' | 'extractor' | 'upload', required
    - `dataType` 'transactions' | 'balances' | 'trades' | 'holdings' | 'orders' | 'loans' | 'receipts' | 'invoices' | 'documents', required
    - `sourceConfig` object
    - `destinationConfig` object
    - `fieldMappings` object[]
      - `sourceField` string, required
      - `destinationField` string, required
      - `destinationFieldType` string
    - `dataTypeOptions` object
    - `extractionConfig` object
      - `extractionFields` object[], required
        - `key` string
        - `name` string, required
        - `type` string, required
        - `description` string
        - `examples` string[]
        - `isItemField` boolean
      - `itemizePerRow` boolean, required
      - `extractionInstructions` string
    - `schedule` object
      - `enabled` boolean, required
      - `frequency` 'hourly' | 'daily' | 'weekly' | 'monthly', required
      - `dayOfWeek` integer: Day of week for weekly schedules (0 = Sunday, 6 = Saturday)
      - `dayOfMonth` integer: Day of month for monthly schedules
      - `timeOfDay` string, required: "HH:MM" UTC format, e.g. "09:30"
    - `state` object, required
    - `order` number, required
    - `createdAt` string, required
    - `updatedAt` string, required

## Other responses

- `400`: Invalid `scope` value, or `scope=family` was requested against a portal workspace
- `401`: Unauthorized
- `403`: Forbidden — `scope=family` requires admin+ role

---

[API](https://skmtc.dev/banksync/apis/banksync-api.md) · [All operations](https://skmtc.dev/banksync/apis/banksync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/banksync/apis/banksync-api/revisions/94465f5ee922?raw)