REST API Documentation¶
What is a REST API?¶
A REST API (Application Programming Interface) lets you programmatically retrieve event data created by partners using their referral code. With our Partner REST API, you can:
- Retrieve events linked to a partner referral code with sorting, filtering, and pagination
- Attach custom metadata to partners and their events during signup for targeted filtering
- Receive real-time webhooks when a partner creates a new event
- Dynamically embed event checkouts on your website using button, card, or full-page formats
Ready to get started? REST API access requires a partner referral code and configuration. Please reach out to our team to discuss your integration needs and get set up.
APIs¶
-
GET /partner/events
Retrieve events linked to a partner referral code.