Skip to main content
POST
Get aggregated events (batch)

Authorizations

Authorization
string
header
required

Authenticate using one of two formats:

  • Organization/user token: Token <your-token>
  • Stytch JWT: Bearer <your-jwt>

Body

start_date
string<date>

Filter events on or after this date (ISO 8601).

end_date
string<date>

Filter events on or before this date (ISO 8601).

created_at_gte
string<date-time>

Filter events created at or after this datetime.

created_at_lte
string<date-time>

Filter events created at or before this datetime.

updated_at_gte
string<date-time>

Filter events updated at or after this datetime.

updated_at_lte
string<date-time>

Filter events updated at or before this datetime.

company_domain
string

Filter by a single company domain (e.g. spacex.com).

company_uid
string

Filter by a single company slug/prismic UID.

company_id
string

Filter by a single company ID.

company_domains
string[]

List of company domains.

company_ids
string[]

List of company IDs.

types
string

Comma-separated event types: funding-round, secondary-transaction, company-milestone, corporate-action.

subtypes
string

Comma-separated event subtypes (e.g. stock_split, ipo).

include_citations
boolean
default:false

Attach citation payloads to events.

pagination
enum<string>

Pagination mode. Default: page.

  • page - page
  • cursor - cursor
Available options:
page,
cursor
page
integer

Page number (offset pagination). Default: 1.

page_size
integer

Results per page. Default: 30, max: 100.

page_after
string

Cursor for the next page (cursor pagination only).

page_before
string

Cursor for the previous page (cursor pagination only).

api_version
enum<string>

Response schema version. Default: v1.

  • v1 - v1
  • v0 - v0
  • legacy - legacy
Available options:
v1,
v0,
legacy

Response

Paginated list of events with metadata. Same shape as GET.

events
object[]
required
pagination
object
required
meta
object
required