# Redbark Sync

- [Getting Started](https://redbark.com/docs/index.md): Connect bank and brokerage accounts, then sync transactions, balances, holdings, and trades to the tools you use.
- [Syncs](https://redbark.com/docs/syncs.md): Create and manage automatic syncs from your bank or brokerage accounts to each connected destination.
- [Connections](https://redbark.com/docs/connections.md): Connect and manage banks and brokerages, monitor connection health, and renew consent when access expires.
- [Brokerage Accounts](https://redbark.com/docs/brokerage.md): Connect brokerage accounts to access holdings and trade history. See which brokerages support holdings, trades, or both.
- [Documents](https://redbark.com/docs/documents.md): Import statements and receipts as transactions when a bank or brokerage connection is not available.
- [Destinations](https://redbark.com/docs/destinations.md): Choose where Redbark sends your financial data and compare the records supported by each destination type.
- [Custom categories](https://redbark.com/docs/categories.md): Define a custom transaction taxonomy and map categories supplied by banks and enrichment providers into it.
- [Rules](https://redbark.com/docs/rules.md): Create ordered rules to skip, recategorise, rename, or annotate transactions before they reach a destination.
- [Sync activity](https://redbark.com/docs/runs.md): Review sync history, status, timing, and per-account results, and learn how to diagnose an unsuccessful run.
- [Consents](https://redbark.com/docs/consents.md): Review and manage the Consumer Data Right consents that authorize Redbark to access your Australian bank data.
- [Google Sheets](https://redbark.com/docs/google-sheets.md): Connect Google Sheets and continuously sync bank transactions, balances, holdings, and trades to your spreadsheet.
- [Airtable](https://redbark.com/docs/airtable.md): Connect an Airtable workspace and continuously sync bank transactions into a base and table that you choose.
- [Notion](https://redbark.com/docs/notion.md): Connect a Notion workspace and continuously sync bank transactions into a database, with typed properties for each field.
- [You Need a Budget](https://redbark.com/docs/ynab.md): Connect a YNAB budget and automatically import transactions from supported Australian and New Zealand banks.
- [Webhook](https://redbark.com/docs/webhook.md): Send transaction, balance, holding, or trade records to your own HTTP endpoint with signed webhook requests.
- [Actual Budget](https://redbark.com/docs/actual-budget.md): Connect supported bank accounts to a self-hosted Actual Budget instance through Redbark's SimpleFIN integration.
- [Sure](https://redbark.com/docs/sure.md): Connect Australian bank accounts to a self-hosted Sure instance through Redbark's SimpleFIN integration.
- [Firefly III](https://redbark.com/docs/firefly-iii.md): Connect Australian bank accounts to a self-hosted Firefly III instance through Redbark's SimpleFIN integration.
- [MCP Server](https://redbark.com/docs/mcp-server.md): Connect AI agents to Redbark so they can read banking data and manage syncs through controlled API access.
- [CDR overview](https://redbark.com/docs/compliance/cdr-overview.md): Learn how Redbark operates under Australia's Consumer Data Right as a CDR Representative of accredited provider Fiskil.
- [Consent and data handling](https://redbark.com/docs/compliance/consent-and-data.md): Learn how bank-data consent is created, notified, renewed, and withdrawn, and what information Redbark stores.
- [API v2 overview](https://redbark.com/docs/api-reference/v2/overview.md): Learn the Redbark API v2 conventions for identifiers, pagination, errors, idempotency, versioning, and access scopes.
- [Account and API keys](https://redbark.com/docs/api-reference/v2/account-and-keys.md): Inspect the authenticated Redbark account and create, restrict, rotate, or revoke API v2 access keys securely.
- [Connections, accounts and transactions](https://redbark.com/docs/api-reference/v2/banking.md): Read live banking and brokerage connections, accounts, balances, details, transactions, holdings, and trades through API v2.
- [Connecting banks and destinations](https://redbark.com/docs/api-reference/v2/connect.md): Link sessions for bank consent, connection lifecycle, institutions, destination links and destinations
- [Syncs, runs and categories](https://redbark.com/docs/api-reference/v2/syncs.md): Create and run syncs through API v2, monitor their execution, and manage category mappings and custom taxonomies.
- [Rules](https://redbark.com/docs/api-reference/v2/rules.md): Create and attach ordered API v2 rules that skip, recategorise, rename, or annotate transactions before delivery.
- [Events and event destinations](https://redbark.com/docs/api-reference/v2/events.md): Receive signed Redbark events at a webhook endpoint, inspect the 30-day event log, and redeliver unsuccessful notifications.
- [Errors](https://redbark.com/docs/api-reference/v2/errors.md): Handle Redbark API v2 errors using the documented response format, HTTP statuses, error codes, and recovery actions.
- [Migrating from v1](https://redbark.com/docs/api-reference/v2/migrating-from-v1.md): Migrate a Redbark API integration from v1 to v2, including endpoint mappings, response shape changes, and new capabilities.
- [Retrieve the account](https://redbark.com/docs/api-reference/v2/account/retrieve-the-account.md): The account behind the API key: plan, entitlements, timezone and the key itself. Any key can call this to introspect its own scopes.
- [List API keys](https://redbark.com/docs/api-reference/v2/api-keys/list-api-keys.md): Every API key on the account, most recently created first. Secrets are never included; a secret is only ever returned once, on creation or rotation.
- [Create an API key](https://redbark.com/docs/api-reference/v2/api-keys/create-an-api-key.md): Creates a restricted key. Scopes are required and must be a subset of the calling key's scopes. The secret is returned once, in this response only.
- [Retrieve an API key](https://redbark.com/docs/api-reference/v2/api-keys/retrieve-an-api-key.md): Retrieves one API key by id. The secret is never included; it is shown only once, on creation or rotation.
- [Update an API key](https://redbark.com/docs/api-reference/v2/api-keys/update-an-api-key.md): Rename or change metadata. Scopes are immutable after creation; rotate or create a new key instead.
- [Revoke an API key](https://redbark.com/docs/api-reference/v2/api-keys/revoke-an-api-key.md): Revokes the key immediately; it stops authenticating right away. Revoking an already-revoked key is a no-op.
- [Rotate an API key](https://redbark.com/docs/api-reference/v2/api-keys/rotate-an-api-key.md): Mints a replacement with the same name, scopes, allowlist and expiry and returns its secret once. The old key keeps working until the grace period ends (max 7 days). Optional JSON body `{ "grace": "7d" }`.
- [List connections](https://redbark.com/docs/api-reference/v2/connections/list-connections.md): Bank and brokerage connections on the account, newest first. Filter by `status` (repeat with `status[]=` for several) or `provider`.
- [Retrieve a connection](https://redbark.com/docs/api-reference/v2/connections/retrieve-a-connection.md): Retrieves one connection by id, with its computed status. Pass `include[]=accounts` to embed its accounts.
- [Revoke a connection](https://redbark.com/docs/api-reference/v2/connections/revoke-a-connection.md): Withdraws consent at the provider (Fiskil revoke, Akahu token delete, SnapTrade deregister), disables dependent syncs, and queues the data deletion. Emits `connection.revoked`.
- [Reauthorize a connection](https://redbark.com/docs/api-reference/v2/connections/reauthorize-a-connection.md): Returns a link session bound to this connection. Completing it renews the consent in place.
- [Refresh a connection](https://redbark.com/docs/api-reference/v2/connections/refresh-a-connection.md): Queues a run for every enabled sync that reads this connection (skipping any already running). Returns the queued runs.
- [List consents](https://redbark.com/docs/api-reference/v2/consents/list-consents.md): CDR consent arrangements (and their brokerage and NZ equivalents), newest first.
- [Retrieve a consent](https://redbark.com/docs/api-reference/v2/consents/retrieve-a-consent.md): Retrieves one consent arrangement by id.
- [List accounts](https://redbark.com/docs/api-reference/v2/accounts/list-accounts.md): Accounts across every connection, newest first. Filter to one connection with `connection`.
- [Retrieve an account](https://redbark.com/docs/api-reference/v2/accounts/retrieve-an-account.md): Retrieves one account by id: its identity, type and currency. Balances and details are separate endpoints.
- [Retrieve the live balance](https://redbark.com/docs/api-reference/v2/accounts/retrieve-the-live-balance.md): Fetched from the bank at request time (through the connection gateway cache). Never stored.
- [Retrieve account details](https://redbark.com/docs/api-reference/v2/accounts/retrieve-account-details.md): Product name, rates, fees, features and loan details as the bank reports them. Banking accounts only.
- [List transactions](https://redbark.com/docs/api-reference/v2/transactions/list-transactions.md): Live from the bank for one account, newest first. Amounts are integer minor units; `category` is the user category the transaction resolves to. When the 5,000 row ceiling is hit the response carries `X-Redbark-Truncated: true` and a non-null next_page_url.
- [Retrieve a transaction](https://redbark.com/docs/api-reference/v2/transactions/retrieve-a-transaction.md): Looks the transaction up by provider id within the given account. Requires `account`.
- [List holdings](https://redbark.com/docs/api-reference/v2/holdings/list-holdings.md): Live positions for one brokerage account.
- [List trades](https://redbark.com/docs/api-reference/v2/trades/list-trades.md): Executed trades for one brokerage account, newest first.
- [List provider categories](https://redbark.com/docs/api-reference/v2/categories/list-provider-categories.md): The fixed category vocabulary banks and enrichment assign to transactions (what v1 served at /categories). Subcategories carry their parent. Not paginated.
- [List categories](https://redbark.com/docs/api-reference/v2/categories/list-categories.md): Your taxonomy: groups (parent null) and their categories, in display order. Seeds the default taxonomy on first use. Filters: `parent` (a group id, or `none` for groups only), `archived`.
- [Create a group or category](https://redbark.com/docs/api-reference/v2/categories/create-a-group-or-category.md): Omit `parent` to create a group; pass a group id to create a category inside it.
- [Reset the taxonomy](https://redbark.com/docs/api-reference/v2/categories/reset-the-taxonomy.md): Drops every group, category and source claim and reseeds the default template. Requires `{ "confirm": true }`.
- [Retrieve a category](https://redbark.com/docs/api-reference/v2/categories/retrieve-a-category.md): Retrieves one group or category by id.
- [Update a category](https://redbark.com/docs/api-reference/v2/categories/update-a-category.md): Rename, recolour, reparent (categories only), reorder or archive.
- [Update a category (PATCH alias)](https://redbark.com/docs/api-reference/v2/categories/update-a-category-patch-alias.md): Rename, recolour, reparent (categories only), reorder or archive.
- [Delete a group or category](https://redbark.com/docs/api-reference/v2/categories/delete-a-group-or-category.md): A group with categories returns 409 `category_has_children` unless `cascade=true`. Pass `reassign_to` to move this category's source claims onto another category; otherwise its sources fall back to the provider category.
- [Replace the claimed sources](https://redbark.com/docs/api-reference/v2/categories/replace-the-claimed-sources.md): Sets which provider categories route to this category. A source belongs to one category, so claiming it moves it; the response lists where each moved source came from.
- [List syncs](https://redbark.com/docs/api-reference/v2/syncs/list-syncs.md): Syncs on the account, newest first. Filter by `status` (repeat with `status[]=` for several), `enabled` or `destination`; pass `include[]=latest_run` to embed each sync's most recent run.
- [Create a sync](https://redbark.com/docs/api-reference/v2/syncs/create-a-sync.md): Creates a sync from accounts to a destination and queues its first run. The destination must be active (have a target); YNAB needs account_mappings; brokerage accounts need a Sheets destination. One sync per destination.
- [Retrieve a sync](https://redbark.com/docs/api-reference/v2/syncs/retrieve-a-sync.md): Retrieves one sync by id. Pass `include[]=latest_run` to embed its most recent run.
- [Update a sync](https://redbark.com/docs/api-reference/v2/syncs/update-a-sync.md): Partial update: name, enabled, accounts, account mappings, options and metadata. Destination and type are fixed; create a new sync to change them.
- [Update a sync (PATCH alias)](https://redbark.com/docs/api-reference/v2/syncs/update-a-sync-patch-alias.md): Partial update: name, enabled, accounts, account mappings, options and metadata. Destination and type are fixed; create a new sync to change them.
- [Delete a sync](https://redbark.com/docs/api-reference/v2/syncs/delete-a-sync.md): Removes the sync and its run history. Rulesets and destinations are left in place.
- [Run a sync now](https://redbark.com/docs/api-reference/v2/syncs/run-a-sync-now.md): Queues a run and returns it with status `queued`. Poll `GET /v2/sync_runs/{id}` or subscribe to `sync_run.*` events. 409 `sync_already_running` while a run is queued or running.
- [Resync from the start date](https://redbark.com/docs/api-reference/v2/syncs/resync-from-the-start-date.md): Rewinds the sync so the next run re-reads from `options.data_from`, then queues that run. Requires `{ "confirm": true }`.
- [List category mappings](https://redbark.com/docs/api-reference/v2/syncs/list-category-mappings.md): How provider categories map onto destination categories for this sync (YNAB budget categories).
- [Replace category mappings](https://redbark.com/docs/api-reference/v2/syncs/replace-category-mappings.md): Replaces the full set of provider-to-destination category mappings for this sync. The sync must have a destination; each source category can appear at most once.
- [List runs for a sync](https://redbark.com/docs/api-reference/v2/sync-runs/list-runs-for-a-sync.md): Runs from the last 90 days, newest first.
- [Retrieve a run](https://redbark.com/docs/api-reference/v2/sync-runs/retrieve-a-run.md): Retrieves one sync run by id, with its status and any error.
- [Cancel a queued run](https://redbark.com/docs/api-reference/v2/sync-runs/cancel-a-queued-run.md): Only runs still `queued` can be cancelled; a run that has started returns 409 `run_not_cancellable`.
- [List rulesets](https://redbark.com/docs/api-reference/v2/rules/list-rulesets.md): Rulesets on the account, newest first.
- [Create a ruleset](https://redbark.com/docs/api-reference/v2/rules/create-a-ruleset.md): Creates an empty, enabled ruleset. Attach it to a sync with POST /v2/syncs/{id}/rulesets, then add rules.
- [Retrieve a ruleset](https://redbark.com/docs/api-reference/v2/rules/retrieve-a-ruleset.md): Retrieves one ruleset by id, with its rule count and the syncs it is attached to.
- [Update a ruleset](https://redbark.com/docs/api-reference/v2/rules/update-a-ruleset.md): Rename, enable/disable or change metadata.
- [Delete a ruleset](https://redbark.com/docs/api-reference/v2/rules/delete-a-ruleset.md): Rules and sync attachments go with it.
- [Duplicate a ruleset](https://redbark.com/docs/api-reference/v2/rules/duplicate-a-ruleset.md): Optional JSON body `{ "name": "…" }`.
- [List rules in a ruleset](https://redbark.com/docs/api-reference/v2/rules/list-rules-in-a-ruleset.md): The rules in this ruleset, in evaluation order (position). Rules run top to bottom; the first match wins.
- [Create a rule](https://redbark.com/docs/api-reference/v2/rules/create-a-rule.md): Up to 20 rules per ruleset; new rules go last.
- [Reorder rules](https://redbark.com/docs/api-reference/v2/rules/reorder-rules.md): Pass every rule id in the ruleset, in the desired order.
- [Preview a ruleset](https://redbark.com/docs/api-reference/v2/rules/preview-a-ruleset.md): Dry run: evaluates the ruleset against recent transactions of one account and returns what each rule would do. Nothing is written. Heavy tier.
- [Retrieve a rule](https://redbark.com/docs/api-reference/v2/rules/retrieve-a-rule.md): Retrieves one rule by id, with its conditions and action.
- [Update a rule](https://redbark.com/docs/api-reference/v2/rules/update-a-rule.md): Rename, change conditions, action, enabled state or metadata. Fields are replaced whole, not merged.
- [Delete a rule](https://redbark.com/docs/api-reference/v2/rules/delete-a-rule.md): Removes the rule from its ruleset; the remaining rules keep their order.
- [Attach a ruleset to a sync](https://redbark.com/docs/api-reference/v2/rules/attach-a-ruleset-to-a-sync.md): A sync has at most one ruleset; pass `[]` to detach.
- [List destinations](https://redbark.com/docs/api-reference/v2/destinations/list-destinations.md): Destinations on the account, newest first. Filter by `type` (sheets, notion, airtable, ynab or webhook).
- [Create a webhook destination](https://redbark.com/docs/api-reference/v2/destinations/create-a-webhook-destination.md): Webhook destinations are created directly. Sheets, Notion, Airtable and YNAB go through `POST /v2/destination_links`. The signing secret is returned in `config.signing_secret` on create and rotate responses only (shown once); elsewhere it is null.
- [Retrieve a destination](https://redbark.com/docs/api-reference/v2/destinations/retrieve-a-destination.md): Retrieves one destination by id, with its status and target.
- [Update a destination](https://redbark.com/docs/api-reference/v2/destinations/update-a-destination.md): Rename, change the target (spreadsheet/sheet, database, base/table, budget, or webhook url) or metadata. Setting the target on a draft destination makes it active.
- [Update a destination (PATCH alias)](https://redbark.com/docs/api-reference/v2/destinations/update-a-destination-patch-alias.md): Rename, change the target (spreadsheet/sheet, database, base/table, budget, or webhook url) or metadata. Setting the target on a draft destination makes it active.
- [Delete a destination](https://redbark.com/docs/api-reference/v2/destinations/delete-a-destination.md): Removes the destination; syncs that only wrote here are deleted too. 409 `destination_in_use` while a run is writing to it.
- [Rotate a webhook signing secret](https://redbark.com/docs/api-reference/v2/destinations/rotate-a-webhook-signing-secret.md): Webhook destinations only. Issues a new signing secret, returned in `config.signing_secret` on this response only.
- [Re-enable a disabled destination](https://redbark.com/docs/api-reference/v2/destinations/re-enable-a-disabled-destination.md): Clears the consecutive-failure count and resumes writes to the destination.
- [List what a destination offers](https://redbark.com/docs/api-reference/v2/destinations/list-what-a-destination-offers.md): Spreadsheets and sheets (Sheets), databases (Notion), bases and tables (Airtable), budgets, accounts and categories (YNAB). `type` narrows; `parent` scopes to a spreadsheet, base or budget. Live from the provider.
- [Create a link session](https://redbark.com/docs/api-reference/v2/link-sessions/create-a-link-session.md): Mints a hosted consent flow. Send the user to `url`; they sign in to Redbark (same account as the key), complete the bank consent, and land on `return_url`. Poll `GET /v2/link_sessions/{id}` or subscribe to `connection.created`.
- [Retrieve a link session](https://redbark.com/docs/api-reference/v2/link-sessions/retrieve-a-link-session.md): Retrieves one link session by id, including its status and the connection it produced once completed.
- [Create a destination link](https://redbark.com/docs/api-reference/v2/destination-links/create-a-destination-link.md): Hosted OAuth for Sheets, Notion, Airtable or YNAB. On completion a draft destination is created; set its target with `POST /v2/destinations/{id}` (list options at `GET /v2/destinations/{id}/resources`).
- [Retrieve a destination link](https://redbark.com/docs/api-reference/v2/destination-links/retrieve-a-destination-link.md): Retrieves one destination link by id, including its status and the draft destination it produced once completed.
- [List institutions](https://redbark.com/docs/api-reference/v2/institutions/list-institutions.md): Banks available for a provider. Fiskil institutions are listed with current availability; Akahu and SnapTrade pick the institution on their hosted page.
- [List event destinations](https://redbark.com/docs/api-reference/v2/event-destinations/list-event-destinations.md): Webhook endpoints registered to receive events, newest first. Signing secrets are never included.
- [Create an event destination](https://redbark.com/docs/api-reference/v2/event-destinations/create-an-event-destination.md): A webhook endpoint that receives signed thin events. The signing secret is returned in `webhook_endpoint.signing_secret` on create and rotate responses only (shown once); elsewhere it is null. Max 10 per account.
- [Retrieve an event destination](https://redbark.com/docs/api-reference/v2/event-destinations/retrieve-an-event-destination.md): Retrieves one event destination by id. The signing secret is never included.
- [Update an event destination](https://redbark.com/docs/api-reference/v2/event-destinations/update-an-event-destination.md): Rename, change the webhook url, enabled events or metadata.
- [Delete an event destination](https://redbark.com/docs/api-reference/v2/event-destinations/delete-an-event-destination.md): Removes the event destination; no further events are delivered to it.
- [Enable an event destination](https://redbark.com/docs/api-reference/v2/event-destinations/enable-an-event-destination.md): Resumes deliveries and clears the consecutive-failure count.
- [Disable an event destination](https://redbark.com/docs/api-reference/v2/event-destinations/disable-an-event-destination.md): Stops deliveries without deleting the destination; it can be re-enabled at any time.
- [Send a ping event](https://redbark.com/docs/api-reference/v2/event-destinations/send-a-ping-event.md): Emits `event_destination.ping` to this destination only and returns the event.
- [Rotate the signing secret](https://redbark.com/docs/api-reference/v2/event-destinations/rotate-the-signing-secret.md): Issues a new secret and keeps the previous one valid for 24 hours; during the overlap every delivery carries one `v1=` per active secret. The new secret is returned in `webhook_endpoint.signing_secret`.
- [List events](https://redbark.com/docs/api-reference/v2/events/list-events.md): The last 30 days of events for resources this key can read, newest first. Filter with `type[]=` (exact types or families like `sync_run.*`).
- [Retrieve an event](https://redbark.com/docs/api-reference/v2/events/retrieve-an-event.md): The full event with `data`, `changes` and its delivery attempts.
- [Redeliver an event](https://redbark.com/docs/api-reference/v2/events/redeliver-an-event.md): Queues a fresh delivery to every subscribed destination within the 30 day window. Optional JSON body `{ "event_destination": "ed_…" }` limits it to one destination.
- [CLI](https://redbark.com/docs/api-reference/cli.md): Install and authenticate the Redbark CLI to query accounts, transactions, balances, holdings, and trades from a terminal.
- [SimpleFIN](https://redbark.com/docs/api-reference/simplefin.md): Connect Actual Budget, Sure, Firefly III, and other SimpleFIN applications directly to supported bank data.
- [MCP Server](https://redbark.com/docs/api-reference/mcp.md): Connect compatible AI agents to Redbark's MCP server for controlled access to banking and brokerage data.
- [Webhook Payload](https://redbark.com/docs/api-reference/webhooks.md): Implement a webhook destination using Redbark's payload format, delivery headers, and HMAC signature verification.
- [REST API](https://redbark.com/docs/api-reference/overview.md): Use Redbark's REST API for programmatic access to bank accounts, balances, transactions, and connections.
- [Sample Responses](https://redbark.com/docs/api-reference/sample-responses.md): Coherent example JSON responses for every endpoint — use these as fixtures to test your parsing code before you create a trial account
- [List Connections](https://redbark.com/docs/api-reference/connections.md): Retrieve the bank connections available to the authenticated Redbark user, including provider and status.
- [List Accounts](https://redbark.com/docs/api-reference/accounts.md): Retrieve a paginated list of bank accounts for the authenticated Redbark connection, including account identifiers.
- [Get Account Details](https://redbark.com/docs/api-reference/account-details.md): Retrieve live product details from the bank, including interest rates, fees, features, and loan information.
- [Get Balances](https://redbark.com/docs/api-reference/balances.md): Retrieve current balances directly from the bank for one account or a selected set of connected accounts.
- [List Transactions](https://redbark.com/docs/api-reference/transactions.md): Retrieve paginated transactions for a bank connection, with optional date range and account filters.
- [List Categories](https://redbark.com/docs/api-reference/categories.md): Retrieve Redbark's transaction category vocabulary, including category identifiers and parent relationships.
- [List Holdings](https://redbark.com/docs/api-reference/holdings.md): Retrieve current portfolio positions for a brokerage connection, including quantities and market values.
- [List Trades](https://redbark.com/docs/api-reference/trades.md): Retrieve paginated trade history for a brokerage connection, with optional account and date range filters.
- [CLI](https://redbark.com/docs/api-reference/cli.md): Install and authenticate the Redbark CLI to query accounts, transactions, balances, holdings, and trades from a terminal.
- [SimpleFIN](https://redbark.com/docs/api-reference/simplefin.md): Connect Actual Budget, Sure, Firefly III, and other SimpleFIN applications directly to supported bank data.
- [MCP Server](https://redbark.com/docs/api-reference/mcp.md): Connect compatible AI agents to Redbark's MCP server for controlled access to banking and brokerage data.
- [Webhook Payload](https://redbark.com/docs/api-reference/webhooks.md): Implement a webhook destination using Redbark's payload format, delivery headers, and HMAC signature verification.

## OpenAPI Specs

- [v2](/docs/openapi/v2.json)