logo

FAQ

Frequently Asked Questions about the Kommunity API.

What is the difference between /events and /events/id?

  • /events is for listing and creating events.
  • /events/id is for retrieving, updating, or deleting a specific event.

What does a typical error response look like?

{
  "success": false,
  "error": "Error message",
  "details": "Optional details"
}

How do I update only part of an event?

Use the PATCH /events/id endpoint. All fields are optional; only include the fields you want to update.

What is the maximum number of custom questions per event?

You can add up to 3 custom questions per event.

How do I cross-post events to other platforms?

Use the crossPost object in the event schema to specify platforms like Luma, Eventbrite, or Meetup.

Events can only be cross-posted during the creation process. Once an event is created, cross-posting cannot be done afterward.

Only free events can be cross-posted.

How does pagination work for listing events?

When using GET /events, you can control pagination with:

  • limit parameter (default: 10) - Number of events per page
  • offset parameter (default: 0) - Number of events to skip

The response includes pagination metadata with total, limit, offset, and hasMore fields.

How do I update ticket information for an event?

Use the PATCH /events/id endpoint and include a tickets array with the updated ticket details. Each ticket should have a name and price. Include the ticket id to update existing tickets.

Can I filter events by category or other properties?

Currently, the API returns all events associated with your company.

How do I manage custom questions for attendees?

Include a questions array when creating or updating an event. Each question requires a question string and required boolean. Use the id field to update existing questions.

More Questions?

If you have more questions, please contact us.