Query Pool Definition Items

Retrieves a list of up to 1,000 pool definition items, given the provided paging, filtering, and sorting.

Removed pool definition items aren't returned. Pool definition items are created and removed asynchronously after calls to Add Items to Benefit and Remove Items from Benefit, so recent changes may take a short time to appear in the results.

To include additional details in each returned pool definition item, pass 1 or more values in the fields parameter. If the related data isn't available, the enrichment details may be omitted from the response. The base fields of each pool definition item, including the id and externalId of each program definition, are always returned.

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

• id is sorted in ASC 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, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC
externalId	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC
providerAppId	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC
category	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC
namespace	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC
poolDefinitionId	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC
createdDate	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte	Sort: ASC, DESC
itemSetId	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC
programDefinitions.id	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC
programDefinitions.externalId	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC
benefitKey	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC
itemSearchKey	$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWith	Sort: ASC, DESC