v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Events

Get all events

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

get/v1/events

Query parameters

starting_after_uuidstring

A cursor for pagination. Returns all events occuring after the specified UUID (exclusive). Events are sorted according to the provided sort_order param.

resource_uuidstring

The UUID of the company. If not specified, will return all events for all companies.

limitstring

Limits the number of objects returned in a single response, between 1 and 100. The default is 25

event_typestring

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'asc' | 'desc'

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

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

Successful

uuidstring required

Unique identifier for the event.

event_typestring

Description of the event (e.g., payroll.submitted, or company.form.signed).

resource_type'Company'

Name of the parent resource of the described entity.

resource_uuidstring

Unique identifier for the parent resource.

entity_typestring

Name of the entity that the event corresponds to.

entity_uuidstring

Unique identifier for the entity.

timestampinteger

Time at which this event was created. Measured in seconds since the Unix epoch.