API reference · v1
The Sway API
A REST API for AI agents and third-party developers to query and act on Sway data: workspaces, bank accounts, invoices, payments and the ledger.
- Base URL
https://api.business.swayapp.io/v1- Auth
Authorization: Bearer <token>- Format
- JSON · OpenAPI 3.1.0 · 19 resources
Guides
How to send a key, read a whole list and handle an error, with code you can copy.
AuthenticationSend an API key as a bearer token, limit it to the resources your software needs with scopes, and replace it before it expires.PaginationRead a whole list page by page with its cursor, fetch items by their IDs, keep only the fields you need, and page through search results.ErrorsRead the status and the stable code of an error, find its cause in its details, stay under the rate limit, and retry only what is safe to retry.Claude connectorConnect Claude Desktop to your Sway workspaces with an API key, then ask Claude about your invoices, bank transactions and ledger, and let it act when you allow it.
Ask Claude about your Sway dataThe Sway connector for Claude Desktop reads your workspaces through the API, with a key that you limit to what Claude may see. Set up the Claude connector
Resources
Each resource has its own page: its endpoints, its object, and a sample of every request and response.
Workspace
- WorkspacesA workspace holds the bank accounts, invoices, payments and accounting of one company.3 endpoints
- MembershipsA membership gives a user a role in a workspace.3 endpoints
- InvitationsAn invitation asks a person, by email, to join a workspace with a given role.6 endpoints
- ConsentsA consent lets Sway read the data of bank accounts or initiate payments from them.7 endpoints
Banking
- Bank accountsA bank account, connected through a consent or managed offline, holds its transactions and past balances.15 endpoints
- Currency exchangesA currency exchange holds the exchange rates from one base currency to other currencies.1 endpoint
Billing
- InvoicesAn invoice is a sales invoice or a supplier bill of the workspace.12 endpoints
- CounterpartiesA counterparty is a customer or a supplier the workspace trades with.6 endpoints
- ProductsA product is a good or a service with the sale and purchase details used on invoices.5 endpoints
Payments
- PaymentsSummarize a payment before you create or initiate it.1 endpoint
- Draft paymentsA draft payment is a payment prepared in Sway and not yet sent to the bank.4 endpoints
- Initiated paymentsAn initiated payment is a payment sent to the bank for execution.3 endpoints
Accounting
- Ledger entriesA ledger entry books an amount to an account of the chart of accounts.6 endpoints
- Chart of accountsA chart of accounts lists the accounts and the account groups of the workspace accounting.11 endpoints
- Tax typesA tax type sets a tax rate and the accounts that book the tax.4 endpoints
- Account coding rulesAn account coding rule codes the bank transactions that match its conditions.11 endpoints
Files and account
Release notes tagged API
All API changesAPI changelog
- Core Services 1.225.0NewA documented openapi.json now describes the Sway API with each release
- Core Services 1.225.0NewThe API reference now documents the shared types
- Core Services 1.225.0NewThe API reference now points to the api.business.swayapp.io domain
- Core Services 1.222.0FixImproved handling of pagination edge cases
- Core Services 1.221.0NewUpload bank statements to a bank account and parse their transactions directly through the API
- Core Services 1.220.0NewUpload invoices, bills and bank statements straight through the API
- Core Services 1.216.0FixInvoice search returns receivable invoices too, and finds an invoice by its counterparty name
- Web App 1.45.0NewA new developer page lets you create, view and revoke your API keys, with scopes and expiry of your choice
- Core Services 1.215.0NewYou can now create API keys with their own expiry date and permission scopes
- Core Services 1.211.0NewAdd support to download exported files
- Core Services 1.207.0NewSway now offers a REST API with API key support, making it possible to integrate Sway with external tools and services
Each entry links to the release that shipped it, with every other change of that release.
Start building on your own data.
Create an account, open Profile › Developer and create a key scoped to the resources you need. Questions about an integration? The team answers them on a call.