Query Pool Definition Items

Retrieves a list of up to 1,000 pool definition items based on the specified paging, filtering, and sorting. To learn how to query pool definition items, see API Query Language.

Pass 1 or more values in the fields parameter to populate additional data:

• POOL_DEFINITION: Populates poolDefinition with the pool definition's display name, description, and credit configuration.
• PROGRAM_DEFINITION: Populates programDefinitions with displayName and description. Use this field to show which plans grant access to a specified item.
• BENEFIT: Populates benefitInfo with the benefit's credit price, display name, and description.
• ITEM: Populates itemInfo with the catalog item's display name.

Enrichment data is silently absent if the source data is unavailable.

Property	Filters	Sort
id	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
externalId	$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
category	$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
poolDefinitionId	$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
itemSetId	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
programDefinitions.id	$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte	Sort: ASC, DESC
programDefinitions.externalId	$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