Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

Query Parameters

event_type
enum<string>[]

Return only events of these exact types. Repeat the parameter for several types.

Available options:
dunning.handed_to_collection,
dunning.level_advanced,
invoice.cancelled,
invoice.created,
invoice.paid,
invoice.written_off,
mandate.balance_updated,
mandate.created,
mandate.message.created,
mandate.state.changed,
mandate.status_update.published,
order.accepted,
order.expired,
order.message.created,
order.rejected,
order.submitted,
order.withdrawn,
payment.reported,
request_to_client.answered,
request_to_client.created,
single_mandate_statement.cancelled,
single_mandate_statement.published,
statement.cancelled,
statement.published
limit
integer
default:10

Number of results to return (maximum 100).

Required range: 1 <= x <= 100
since
string

Opaque cursor taken from the cursor (or next) field of a previous page. Omit it to start at the oldest retained event (30 days). Entries become visible about 60 seconds after they are recorded, so a cursor never runs ahead of an event that is still being written.

Response

One page of the event feed. There is no total count.

cursor
string | null
required

Opaque position after the last event on this page; pass it as since on the next poll. Present on every page: it equals next while more events are waiting, stays set on the last page, repeats since when the page is empty, and is null only for an empty page requested without since.

next
string | null
required

Opaque cursor of the last event on this page; pass it as since to continue. Null when the feed has no further event yet.

results
(Order lifecycle event · object | Order accepted · object | Case lifecycle event · object | Case status update · object | Order message event · object | Case message event · object | Client request event · object | Payment event · object | Statement event · object | Per-case statement event · object | Invoice and dunning event · object)[]
required

Events in feed order, oldest first. Each entry is the envelope delivered for the same event ID. Only events retained for the last 30 days and permitted by the credential’s resource read scopes are included; new events become visible after about 60 seconds.

Body of every Case event, as delivered to a webhook endpoint and as listed by GET /v2/events/. Dispatch on type: each event type maps to exactly one family whose data keys are required or conditional as documented by that family.

Example: