Skip to main content
GET
List Company Reserve Updates

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

Query Parameters

categoryId
string<uuid>

Only feed rows for this reserved category

asOfDate
string<date>

Return the feed as of this date (ISO YYYY-MM-DD); omit for the current feed

limit
integer
default:50

Page size (default 50, maximum 200)

Required range: 1 <= x <= 200
cursor
string

The previous page's nextCursor, echoed verbatim. Opaque — its internals may change shape at any time

Response

One page of the company-wide reserve-update feed, newest first

rows
(User reserve update · object | Eroding payment · object | Reserve history reset · object)[]
required

A company-wide reserve-update feed row, discriminated by kind: a reserve-update feed row (user, erodingPayment, or reset) plus the event it belongs to and, on user and erodingPayment rows, the running reserve. The same rows the app's company-wide Reserve Updates listing and its export show.

nextCursor
string | null
required

Cursor for the next page; null exactly when the feed is exhausted