Skip to main content
Developers

API

Use the Synci API to work with your own accounts, balances and transactions from your own scripts and tools. Create an API token in the dashboard and find the full reference at docs.synci.io.

Written By Matias

Last updated 1 day ago

The Synci API gives you programmatic access to your own Synci account: your connected accounts, balances, transactions and holdings, plus the rules, transfer links, destinations and webhooks you've set up. Use it for your own scripts, reports and automations.

Building something other people will connect to? See Building OAuth apps. If your users won't have a Synci account at all, see Managed apps.

Full API documentation

Everything technical lives on our developer documentation site: authentication and scopes, the full endpoint reference, pagination, errors, rate limits and webhooks.

👉 https://docs.synci.io

The documentation site lets you test requests directly from the browser.


Getting started & authentication

The Synci API uses API tokens (personal access tokens) for access to your own account. All requests must be made over HTTPS and include your token in the Authorization header.

Creating an API token

  1. Log in to your Synci Dashboard.

  2. Open Developers > API tokens and click Create API token.

  3. Permissions: choose Full access, or Custom to limit the token to specific permissions.

  4. Accounts: keep All accounts on to include every connected account, including ones you add later, or turn it off and pick specific accounts.

  5. Name: give the token a name you'll recognize (e.g., "Custom Reporter Script"), then click Create token.

  6. Copy the token immediately. For security reasons, it will only be displayed once. If you lose it, delete it and create a new one.

API tokens are valid for one year. You can change a token's name, permissions and accounts later with Edit token (the token value stays the same), and delete a token at any time from the same tab.

Using an older token? Tokens in the older format, a number followed by a vertical bar and the secret (like 123|abc...), still work for now, but they're being retired. Create a new API token and update your scripts.

Authenticating requests

Include your token as a Bearer token in the HTTP Authorization header:

curl -X GET "https://api.synci.io/api/v1/user" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Accept: application/json"

Where to go next

  • Authentication: token types and the full list of permissions (scopes).

  • API reference: every endpoint, with request and response examples.

  • Rate limits: how many requests you can make and how to handle a 429 response.

  • Pagination and Errors: working with lists and error responses.

  • Webhooks: get notified when something changes instead of polling. See also Webhooks.

Version 1 of the API is the stable version to build on. Version 2 is in alpha and only holds a few endpoints so far, so read the API v2 introduction before you use it.