Skip to main content
GET
List audit events

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Query Parameters

businessId
string
required
resource_type
enum<string>
Available options:
filing,
remittance,
requirement
resource_id
string

Filter events for a specific resource

event_type
enum<string>
Available options:
filing.upcoming,
filing.created,
filing.blocked,
filing.pending,
filing.in_review,
filing.approved,
filing.submitted,
filing.accepted,
filing.rejected,
filing.overdue,
filing.amended,
filing.cancelled,
remittance.created,
remittance.processing,
remittance.completed,
remittance.failed,
requirement.created,
requirement.satisfied,
requirement.waived
since
string<date-time>

Return events after this timestamp

cursor
string

Pagination cursor from previous response

limit
integer
default:25

Number of items per page

Required range: 1 <= x <= 100

Response

200 - application/json

List of events

data
object[]
pagination
object