Pagination, filtering, and sorting

All list endpoints share the same conventions for paging through results, narrowing them down, and controlling what related data is embedded.

Pagination

List endpoints are paginated with page[number] and page[size] query parameters:

GET /api/v1/finance/transactions?page[number]=2&page[size]=50

Default page size: 25

Maximum page size: 100

Responses wrap the results in data and include links and meta for navigation:

{
  "data": [ ... ],
  "links": {
    "first": "https://api.synci.io/api/v1/finance/transactions?page[number]=1",
    "last": "https://api.synci.io/api/v1/finance/transactions?page[number]=9",
    "prev": "https://api.synci.io/api/v1/finance/transactions?page[number]=1",
    "next": "https://api.synci.io/api/v1/finance/transactions?page[number]=3"
  },
  "meta": {
    "current_page": 2,
    "from": 51,
    "to": 100,
    "per_page": 50,
    "total": 423,
    "last_page": 9
  }
}

Iterate by following links.next until it is null, or use meta.last_page.

Filtering

List endpoints accept filter[...] query parameters. The available filters for each endpoint are listed in its reference page. For example, transactions support filters such as:

GET /api/v1/finance/transactions
  ?filter[financial_account_id]=123
  &filter[booking_date_after]=2026-06-01
  &filter[booking_date_before]=2026-06-30
  &filter[search]=spotify

Date-range filters (booking_date_after, booking_date_before, value_date_after, value_date_before) are inclusive on both ends.

Multiple filters combine with AND. Where a filter accepts multiple values, separate them with commas:

GET /api/v1/finance/accounts?filter[integrator]=GOCARDLESS,AKAHU

Sorting

Use the sort parameter with a field name; prefix with - for descending order:

GET /api/v1/finance/transactions?sort=-booking_date

Sortable fields per endpoint are listed in the reference.

Some endpoints can embed related resources in the response via the include parameter, saving you extra round trips:

GET /api/v1/finance/transactions?include=financial_account,enriched

For example, transactions support includes such as financial_account (and its connection and institution via dot notation, like financial_account.financial_connection.institution), transfer_logs, enriched (transaction enrichment data), and trade (brokerage trade details). Available includes are documented per endpoint in the reference; fields backed by an include are absent unless you request it.

Pagination, filtering, and sorting

Pagination#

Filtering#

Sorting#

Including related data#

Pagination

Filtering

Sorting

Including related data