Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

Your project's secret key (pk_…, without the pub segment). Server-side only — never ship it to a browser. Get it from Settings → Projects in the dashboard.

Query Parameters

name
string

Exact event name.

Maximum string length: 80
q
string

Case-insensitive substring match on the event name. Mutually exclusive with name.

Maximum string length: 200
userId
string

Galinum end-user id (eu_…).

Maximum string length: 256
externalUserId
string

Your product's user id.

Maximum string length: 256
since
string

Only events at or after this instant. Epoch milliseconds or an ISO-8601 date.

until
string

Only events at or before this instant. Epoch milliseconds or an ISO-8601 date.

page
integer
default:1

Page number.

Required range: x >= 1
perPage
integer
default:50

Items per page (max 100).

Required range: 1 <= x <= 100

Response

The project's events.

events
object[]
required
total
integer
required
Example:

412

page
integer
required
Example:

1

pageCount
integer
required
Example:

9