POST

Query Participants


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 50 participants, given the provided paging, filtering, and sorting.

Query Participants runs with these defaults, which you can override:

  • createdDate is sorted in DESC order.
  • paging.limit is 50.
  • paging.offset is 0.

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.

PropertyFiltersSort
id$eq, $inSort: ASC, DESC
enrollmentStatus$eq, $inSort: ASC, DESC
progressStatus$eq, $inSort: ASC, DESC
memberId$eq, $inNone
programId$eqNone
createdDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
lastActivityDate$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
progress.totalStepsCompleted$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
enrollmentInfo.startDate$gte, $lte, $gt, $ltSort: ASC, DESC
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Online Programs
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/online-programs/v3/participants/query

Errors

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

Did this help?