/api/lockbox/{financialAccountId}/rules

Returns every split funding rule configured on a lockbox account, active and inactive, as a flat array.

This is the read endpoint behind the rules table in HQ and behind the automatic-distribution block in the web and mobile account details screen. It is the only endpoint of the five that a plain customer calls in normal use.
Returns 200 with an array. An account with no rules returns [], not 404 — an empty array is a valid, normal answer and is also what a caller sees today when the ownership check wrongly lets them through. Ordering follows order ascending; the client renders rules in that sequence, which is also the sequence they execute in.

Path Params
string
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json