POST

Query Join Applications


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 1,000 join applications, given the provided paging, filtering, and sorting.

Members can retrieve their own join applications. Site owners with appropriate permissions can retrieve applications across all members.

Query Join Applications 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, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
memberId$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
programId$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
participantId$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
createdDateSort: ASC, DESC
updatedDateSort: ASC, DESC
status$eq, $in, $ninSort: ASC, DESC
paymentStatus$eq, $in, $ninSort: ASC, DESC
tags.publicTags.tagIds$hasSome, $hasAll, $exists, $isEmptySort: ASC, DESC
tags.privateTags.tagIds$hasSome, $hasAll, $exists, $isEmptySort: 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/participants/v3/join-applications/query

Errors

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

Did this help?