Get all auto-transfer rules

get

https://api.mercury.com/api/v1/auto-transfer-rules

Retrieve a paginated list of the organization's active auto-transfer rules: rules that distribute fixed amounts or percentages of an account's balance to other accounts, and rules that keep an account at a target balance. Pass accountId to return only the rules that manage that account's balance.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

accountId

uuid

ID for a Mercury account.

limit

int64

1 to 1000

Defaults to 1000

Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000

start_after

uuid

The ID of the auto-transfer rule to start the page after (exclusive). When provided, results will begin with the auto-transfer rule immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.

end_before

uuid

The ID of the auto-transfer rule to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.

order

string

enum

Defaults to asc

Sort order. Can be 'asc' or 'desc'. Defaults to 'asc'

Allowed:

Responses

400

Invalid order or end_before or start_after or limit or accountId

200