Skip to content
Docs

List Events

The workspace event log, newest first.

GET/api/v1/events

Requires an API key with the read scope.

The events FoxReach stored for this workspace: the ones webhooks carry, and the audit entries written for changes made through the API (for example audit.inbox_thread.categorized). To see which event types you can subscribe to, use List Event Types. Internal staff events are never listed.

Query Parameters#

typestringquery

Only this event type, for example lead.created.

startDatestringquery

ISO 8601 time. Only events at or after it. A time without an offset is UTC.

endDatestringquery

ISO 8601 time. Only events at or before it.

pageintegerquery

Page number, starting at 1.

pageSizeintegerquery

Results per page, 1 to 100. Default 50.

Response#

Returns a paginated list in data with meta.page, meta.pageSize, meta.total and meta.totalPages.

Errors#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: read
422A date that is not ISO 8601, or pageSize above 100

Rate Limit#

  • 300 requests per minute, shared by every read call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (read).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Was this page helpful?
View as MarkdownLast updated November 4, 2026