Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

Partner API Bearer key: Authorization: Bearer <key>. Keys are created only through authorized portal or staff flows.

Query Parameters

company
string<uuid>

Return only events of this managed company.

event_type
enum<string>[]

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

Available options:
company.access.confirmed,
company.access.restored,
company.access.revoked,
company.case_submission_readiness.changed,
company.created,
company.user.activated,
company.user.added,
company.user.invite_expired,
company.user.revoked,
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
(Company created · object | Company readiness changed · object | Company access granted or restored · object | Company access revoked · object | Company membership event · object | 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: company lifecycle events of this partner and case events of its accessible companies. Each entry is the envelope a webhook endpoint receives for the same event id.

One row of GET /partner/v2/events/: a Partner lifecycle event or a Case event of a company the Partner has available case access to — the same body a Partner-owned endpoint with a companies selector receives. Dispatch on type.

Example: