Query Pool Items

Retrieves a list of up to 1,000 pool items, based on the specified paging, filtering, and sorting.

When called by a logged-in member without an explicit beneficiary.memberId filter, the response is automatically scoped to the calling member. App callers must include a beneficiary.memberId filter to scope the response to a specific beneficiary.

Query Pool Items runs with these defaults, which you can override:

• createdDate is sorted in DESC order
• cursorPaging.limit is 50

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

Property	Filters	Sort
id	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
createdDate	$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte	Sort: ASC, DESC
externalId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
category	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
providerAppId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
namespace	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
poolId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
itemSetId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
poolDefinitionId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
programDefinitionId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
programId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
beneficiary.memberId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
externalProgramDefinitionId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
externalProgramId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
benefitKey	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
itemSearchKey	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC