List expense rules

This resource is only available to subscribers of the feature, as it is a paid add-on.

Lists recurring expense rules for the account with filters and offset pagination.

Returns one item per rule version (id), not collapsed by prototypeId. By default only active and draft rules are returned; pass status to include inactive or archived.

Each item includes assignedListingsCount but not listingIds; use GET /expense-rules/{id} for the full set of assigned listings.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
status
array of strings
length ≥ 1
Defaults to active,draft

Expense rule statuses to filter by. Send a comma-separated list (status=active,draft) or repeat the parameter. Defaults to active and draft.

status
Allowed:
string

Return only rules currently assigned to this listing (MongoDB ObjectId)

string

Category ID to filter by

string

Vendor ID to filter by (MongoDB ObjectId)

string
length ≤ 255

Case-insensitive contains search on rule name

number
1 to 100
Defaults to 50

Number of expense rules to return (1-100)

number
≥ 0
Defaults to 0

Number of expense rules to skip

string
enum
Defaults to createdAt

Field to sort by

Allowed:
string
enum
Defaults to DESC

Sort order

Allowed:
Responses

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