GET /partner/events¶

Retrieve public events linked to a partner referral code, with sorting, filtering, pagination, and dynamic event data.

Additional resources¶

• Partner API: Setting MetaData
• Event Creation Webhook
• Dynamically Embedding Event Checkouts

Getting started¶

To begin retrieving events, all you need is a valid partner referral code.

Required parameter¶

Example request¶

GET https://3common.com/partner/events?referral_code=hello123

This returns the first page (20 events) linked to the partner with referral code hello123.

Optional query parameters¶

Example request with all parameters¶

GET https://3common.com/partner/events?referral_code=hello123&sort=createdAt&direction=desc&page=1&limit=10&filter=past

This request retrieves the second page of past events, limited to 10 entries, sorted in descending order by creation date.

Response format¶

{
  "data": "EventObject[]",
  "status": "number",
  "error": "string",
  "message": "string",
  "total": "number",
  "page": "number",
  "limit": "number",
  "hasMore": "boolean"
}

Event object (data[])¶

Owner object¶

Advanced use examples¶

Sort by creation date¶

GET https://3common.com/partner/events?referral_code=hello123&sort=createdAt&direction=desc

Filter for past events with pagination¶

GET https://3common.com/partner/events?referral_code=hello123&filter=past&page=1&limit=25

Get upcoming events (ascending start time)¶

GET https://3common.com/partner/events?referral_code=hello123&filter=upcoming&sort=start

Search by metaData properties¶

In this example a user has the following metadata fields set: metaData: { partner_uid: '1234' }. To search for events matching this custom metaData field, specify it as a query parameter in the GET request.

GET https://3common.com/partner/events?referral_code=hello123&partner_uid=1234

This returns all events matching a valid referral_code where partner_uid is 1234.

To learn more about setting metaData, visit Partner API: Setting MetaData.

Error reference¶

REFERRAL_CODE_REQUIRED¶

Cause: The referral_code parameter is missing from the request.

Sample request:

GET https://3common.com/partner/events

Response:

{
  "status": 400,
  "error": "REFERRAL_CODE_REQUIRED",
  "message": "Please provide a referral code. View documentation at https://help.3common.com/ for more information."
}

PARTNER_NOT_FOUND¶

Cause: The referral_code was provided, but no matching partner exists.

Sample request:

GET https://3common.com/partner/events?referral_code=invalid123

Response:

{
  "status": 404,
  "error": "PARTNER_NOT_FOUND",
  "message": "There is no partner associated with this referral code: invalid123. Please check your referral code and try again. View documentation at https://help.3common.com/ for more information."
}

NO_EVENTS_FOUND¶

Cause: The partner exists, but has no events matching the query (e.g., filter or status).

Sample request:

GET https://3common.com/partner/events?referral_code=hello123&filter=upcoming

Response:

{
  "data": [],
  "status": 404,
  "message": "No events found based on the provided filters.",
  "error": "NO_EVENTS_FOUND",
  "total": 0,
  "page": 0,
  "limit": 20,
  "hasMore": false
}

INTERNAL_SERVER_ERROR¶

Cause: A database or unexpected system error occurred.

Sample request:

GET https://3common.com/partner/events?referral_code=hello123

While the request is valid, the backend throws an unexpected exception.

Response:

{
  "status": 500,
  "error": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred. Please try again later."
}