Retrieves a list of pools, given the provided paging, filtering, and sorting.
Query Pools has a default paging limit of 50, which you can override.
For field support for filters and sorting, see Filtering and Sorting.
To learn how to query pools, see API Query Language.
| Field | Supported Filters | Sort |
|---|---|---|
id | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
poolDefinitionId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
programDefinitionId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
programId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
status | $eq, $ne, $exists, $in, $any | Sort: ASC, DESC |
beneficiary | $eq, $ne, $exists, $in, $any | Sort: ASC, DESC |
namespace | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
details.benefits.itemSetId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
details.benefits.providerAppId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
beneficiary.memberId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
beneficiary.wixUserId | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
createdDate | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.