Get all events
GET {{baseUrl}}/v1/events?starting_after_uuid=<string>&resource_uuid=<string>&limit=<string>&event_type=<string>&sort_order=<string>
Fetch all events, going back up to 30 days, that your partner application has the required scopes for. Note that a partner does NOT have to have verified webhook subscriptions in order to utilize this endpoint.
📘 System Access Authentication
This endpoint uses the Bearer Auth scheme with the system-level access token in the HTTP Authorization header.
scope: events:read
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
starting_after_uuid | string | A cursor for pagination. Returns all events occuring after the specified UUID (exclusive). Events are sorted according to the provided sort_order param. | |
resource_uuid | string | The UUID of the company. If not specified, will return all events for all companies. | |
limit | string | Limits the number of objects returned in a single response, between 1 and 100. The default is 25 | |
event_type | string | A string containing the exact event name (e.g. employee.created ), or use a wildcard match to filter for a group of events (e.g. employee.* , *.created , notification.*.created etc.) | |
sort_order | string | A string indicating whether to sort resulting events in ascending (asc) or descending (desc) chronological order. Events are sorted by their timestamp . Defaults to asc if left empty. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
RESPONSES
status: OK
[{"uuid":"f7397a24-57ad-4fae-b011-d258e8232900","event_type":"employee.bank_account.created","resource_type":"Company","resource_uuid":"92a20431-9489-4bde-ad27-6feb20b969d5","entity_type":"BankAccount","entity_uuid":"92a20431-9489-4bde-ad27-6feb20b969d5","timestamp":1686784995}]