Retrieve public events linked to a partner referral code, with sorting, filtering, pagination, and dynamic event data.
Dynamically Embedding Event Checkouts
To begin retrieving events, all you need is a valid partner referral code.
| Parameter | Type | Description |
|---|---|---|
referral_code |
string |
The unique referral code associated with a partner |
GET <https://3common.com/partner/events?referral_code=hello123>
This returns the first page (20 events) linked to the partner with referral code hello123.
| Parameter | Type | Default | Description |
|---|---|---|---|
page |
number |
0 |
Zero-based page index |
limit |
number |
20 |
Max results per page (up to 100) |
sort |
'start' or 'end' or 'createdAt' |
'start' |
Field to sort events by |
direction |
'asc' or 'desc' |
'asc' |
Sort direction |
filter |
'all', 'upcoming', 'past' |
'all' |
Filter based on event date category |
metaData |
string |
undefined |
The metaData property isn’t an explicit field itself, it can be any string key value pair, see example below on how to retrieve data via metaData. Learn more here |