Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

Send the full Business API key from Settings -> API Keys, for example Authorization: Bearer sk_your_api_key.

Query Parameters

page
integer
default:1

One-based page number. Use 1 for the first page and increment it while hasMore is true.

Required range: x >= 1
pageSize
integer
default:20

Maximum number of records requested per page. The shared default is 20 and the shared upper limit is 100; individual endpoints can document a lower maximum.

Required range: 1 <= x <= 100
keyword
string

Search event names and related event text by keyword.

Maximum string length: 200
country
string

Filter events by country name.

Maximum string length: 100
city
string

Filter events by city name.

Maximum string length: 100
date_start_from
string<date>

Inclusive lower bound for the event start date in YYYY-MM-DD format.

date_start_to
string<date>

Inclusive upper bound for the event start date in YYYY-MM-DD format.

event_type
string[]

Filter by one or more event-type labels. Comma-separated input is supported.

quality
string[]

Filter by one or more quality labels. Comma-separated input is supported.

sponsor_match_starred
enum<integer>

Filter by Sponsor Match starred state: 1 for starred or 0 for not starred.

Available options:
0,
1
has_visitors
enum<integer>

Filter by registered Visitor-data availability: 1 when available or 0 when unavailable.

Available options:
0,
1

Response

Paginated events

Standard paginated collection of public event summaries.

items
object[]
required

Records returned on the current page or in the current batch.

total
integer
required

Total matching records across all pages.

page
integer
required

One-based page number returned.

pageSize
integer
required

Maximum records requested for this page.

totalPages
integer
required

Total pages available for the current query.

hasMore
boolean
required

Whether another result page is available.