POST

Query Attendance

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves up to 100 attendance objects, given the specified paging, filtering, and sorting.

When querying attendance information, you can query from the perspective of:

  • A booking. Specify a booking ID to retrieve attendance information for all sessions related to that booking. For example, query by bookingId for a course booking to retrieve a participant's attendance for all course sessions.
  • A session. Specify a session ID to retrieve attendance information for all bookings related to that session.

Query Attendance runs with the following defaults, which you can override:

  • id sorted in ASC order.
  • cursorPaging.limit set to 50.

Only a single filter is supported per query. If you define multiple filters in the same query, only the first is processed.

To learn about working with query methods, see API Query Language.

PropertyFiltersSort
_id$eq, $ne, $in, $ninSort: ASC
bookingId$eq, $ne, $in, $ninSort: ASC
sessionId$eq, $ne, $in, $ninSort: ASC
status$eq, $ne, $in, $ninSort: ASC
numberOfAttendees$eq, $ne, $in, $nin, $lt, $lte, $gt, $gteSort: ASC, DESC
Permissions
Read Bookings - Including Participants
Learn more about app permissions.
Method Declaration
Copy
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?