Read the activity feed for one record

Returns what happened to a single record, newest first. A feed carries only that record's own activities.

pagination reports the totals for the whole filtered result rather than for the page.

entityType'INVOICE' | 'PAYMENT_REQUEST' | 'CUSTOMER' | 'SCHEDULE'

The kind of record an activity belongs to.

Example:INVOICE

The kind of record to read the feed for. Required, together with entityId.

entityIdstring

The record to read the feed for, as a UUID. Required, together with entityType.

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

The record to read the feed for, as a UUID. Required, together with entityType.

typestring[]

Only return activities of these kinds. Repeat the parameter to name more than one, combined with OR. Omit it to return every kind.

[
  "INVOICE_PAID"
]

minCreationTimestring date-time

Only return activities that happened at or after this instant. Inclusive.

Example:2026-08-01T00:00:00Z

Only return activities that happened at or after this instant. Inclusive.

maxCreationTimestring date-time

Only return activities that happened at or before this instant. Inclusive.

Example:2026-08-31T23:59:59Z

Only return activities that happened at or before this instant. Inclusive.

pageinteger

Which page to return, counting from one.

Example:1

Which page to return, counting from one.

sizeinteger

How many activities to return per page. A request for more than the maximum is refused.

Example:50

How many activities to return per page. A request for more than the maximum is refused.

sort'creationTime,desc' | 'creationTime,asc'

How to order the page.

Response

The requested page of activities.