> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # QueryPools # Package: benefitPrograms # Namespace: PoolService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/pools/query-pools.md ## Permission Scopes: SCOPE.BENEFIT_PROGRAMS.READ (PII): SCOPE.BENEFIT_PROGRAMS.READ_LIMITED ## Introduction 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](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting.md). To learn how to query pools, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). --- ## REST API ### Schema ``` Method: queryPools Description: 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](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting.md). To learn how to query pools, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). URL: https://www.wixapis.com/benefit-programs/v1/pools/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md) for more information. - name: sort | type: array | description: List of sort objects. - name: fieldName | type: string | description: Field to sort by. - name: order | type: SortOrder | description: Sort order. Use `ASC` for ascending order or `DESC` for descending order. Default: `ASC` - enum: - ASC: Ascending sort order. - DESC: Descending sort order. Return type: QueryPoolsResponse - name: pools | type: array | description: List of retrieved pools. - name: id | type: string | description: Pool GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the pool is updated. To prevent conflicting changes, the current revision must be passed when updating the pool. Ignored when creating a pool. - name: createdDate | type: string | description: Date and time the pool was created. - name: updatedDate | type: string | description: Date and time the pool was updated. - name: poolDefinitionId | type: string | description: GUID of the associated pool definition. - name: programDefinitionId | type: string | description: GUID of the associated program definition. - name: programId | type: string | description: GUID of the program that contains this pool. - name: status | type: PoolStatus | description: Pool status. - enum: - ACTIVE: Pool is active. - PAUSED: Pool is paused. It can be resumed. - ENDED: Pool is ended. It can't be resumed. - PROVISIONING: Pool provisioning is in progress. This status exists for a short time during processing. - RENEWING: Pool renewing is in progress. This status exists for a short time during processing. - PENDING: Pool is pending - name: beneficiary | type: IdentificationData | description: Pool beneficiary. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: details | type: Details | description: Pool benefits and settings. - name: benefits | type: array | description: List of benefits. - name: benefitKey | type: string | description: Unique identifier for this benefit. This key is consistent across the pool definition and all associated pools that contain this benefit. - name: itemSetId | type: string | description: GUID that is used to associated items with this benefit. - name: price | type: string | description: Price of the benefit in credits. The price is the same for all of this benefit's items. - name: additionalData | type: object | description: Additional information for this benefit. - name: providerAppId | type: string | description: GUID of the app providing the benefit items. - name: displayName | type: string | description: Benefit name. - name: description | type: string | description: Benefit description. - name: creditConfiguration | type: CreditConfiguration | description: Credit settings. If this object is empty, you can't set a price for the benefit. - name: amount | type: string | description: Initial available amount for associated balances. - name: rolloverConfiguration | type: RolloverConfiguration | description: Rollover settings. - name: enabled | type: boolean | description: Whether unused credits roll over to a new cycle when a program renews. - name: balanceCap | type: string | description: Maximum number of credits that can roll over to the next cycle when a program renews. - name: unitDisplayName | type: string | description: Credit unit display name. - name: additionalData | type: object | description: Additional information relating to this object. - name: displayName | type: string | description: Pool name. You may want to use the same name that's used in the associated pool definition. - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. - name: extendedFields | type: ExtendedFields | description: Custom field data for the pool object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: programDefinition | type: ProgramDefinitionInfo | description: Associated program definition information. - name: id | type: string | description: Program definition GUID. - name: externalId | type: string | description: Program definition external GUID. - name: displayName | type: string | description: Display name of the program definition. - name: description | type: string | description: Description of the program definition. - name: program | type: ProgramInfo | description: Information about the program containing the pool. - name: id | type: string | description: Program GUID. - name: externalId | type: string | description: Program external GUID. - name: displayName | type: string | description: Display name of the program. - name: poolDefinitionRevision | type: string | description: Version of the pool definition that this pool was created from. - name: renewalCount | type: integer | description: Number of times this pool has been renewed. - name: metadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### QueryPools ```curl ~~~cURL curl --request POST https://www.wixapis.com/benefit-programs/v1/pools/query \ -H "Content-Type: application/json" \ -H "Authorization: " \ --data '{ "query": { "filter": { "$and": [ { "poolDefinitionId": { "$eq": "64244667-7c54-46da-8d8b-4a1a4ee9a598" } }, { "programId": { "$eq": "8faed6d2-dfdf-44f1-8a71-bcc19d2fbdde" } }, { "status": { "$eq": "ACTIVE" } } ] } } }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.PoolService.queryPools(query) Description: 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](https://dev.wix.com/docs/rest/business-solutions/benefit-programs/pools/filtering-and-sorting.md). To learn how to query pools, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: PoolQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md) for more information. - name: sort | type: array | description: List of sort objects. - name: fieldName | type: string | description: Field to sort by. - name: order | type: SortOrder | description: Sort order. Use `ASC` for ascending order or `DESC` for descending order. Default: `ASC` - enum: - ASC: Ascending sort order. - DESC: Descending sort order. Return type: PROMISE - name: pools | type: array | description: List of retrieved pools. - name: _id | type: string | description: Pool GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the pool is updated. To prevent conflicting changes, the current revision must be passed when updating the pool. Ignored when creating a pool. - name: _createdDate | type: Date | description: Date and time the pool was created. - name: _updatedDate | type: Date | description: Date and time the pool was updated. - name: poolDefinitionId | type: string | description: GUID of the associated pool definition. - name: programDefinitionId | type: string | description: GUID of the associated program definition. - name: programId | type: string | description: GUID of the program that contains this pool. - name: status | type: PoolStatus | description: Pool status. - enum: - ACTIVE: Pool is active. - PAUSED: Pool is paused. It can be resumed. - ENDED: Pool is ended. It can't be resumed. - PROVISIONING: Pool provisioning is in progress. This status exists for a short time during processing. - RENEWING: Pool renewing is in progress. This status exists for a short time during processing. - PENDING: Pool is pending - name: beneficiary | type: IdentificationData | description: Pool beneficiary. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: details | type: Details | description: Pool benefits and settings. - name: benefits | type: array | description: List of benefits. - name: benefitKey | type: string | description: Unique identifier for this benefit. This key is consistent across the pool definition and all associated pools that contain this benefit. - name: itemSetId | type: string | description: GUID that is used to associated items with this benefit. - name: price | type: string | description: Price of the benefit in credits. The price is the same for all of this benefit's items. - name: additionalData | type: object | description: Additional information for this benefit. - name: providerAppId | type: string | description: GUID of the app providing the benefit items. - name: displayName | type: string | description: Benefit name. - name: description | type: string | description: Benefit description. - name: creditConfiguration | type: CreditConfiguration | description: Credit settings. If this object is empty, you can't set a price for the benefit. - name: amount | type: string | description: Initial available amount for associated balances. - name: rolloverConfiguration | type: RolloverConfiguration | description: Rollover settings. - name: enabled | type: boolean | description: Whether unused credits roll over to a new cycle when a program renews. - name: balanceCap | type: string | description: Maximum number of credits that can roll over to the next cycle when a program renews. - name: unitDisplayName | type: string | description: Credit unit display name. - name: additionalData | type: object | description: Additional information relating to this object. - name: displayName | type: string | description: Pool name. You may want to use the same name that's used in the associated pool definition. - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. - name: extendedFields | type: ExtendedFields | description: Custom field data for the pool object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: programDefinition | type: ProgramDefinitionInfo | description: Associated program definition information. - name: _id | type: string | description: Program definition GUID. - name: externalId | type: string | description: Program definition external GUID. - name: displayName | type: string | description: Display name of the program definition. - name: description | type: string | description: Description of the program definition. - name: program | type: ProgramInfo | description: Information about the program containing the pool. - name: _id | type: string | description: Program GUID. - name: externalId | type: string | description: Program external GUID. - name: displayName | type: string | description: Display name of the program. - name: poolDefinitionRevision | type: string | description: Version of the pool definition that this pool was created from. - name: renewalCount | type: integer | description: Number of times this pool has been renewed. - name: metadata | type: CursorPagingMetadata | description: Metadata for the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### queryPools ```javascript import { pools } from '@wix/benefit-programs'; async function queryPools(query) { const response = await pools.queryPools(query); }; ``` ### queryPools (with elevated permissions) ```javascript import { pools } from '@wix/benefit-programs'; import { auth } from '@wix/essentials'; async function myQueryPoolsMethod(query) { const elevatedQueryPools = auth.elevate(pools.queryPools); const response = await elevatedQueryPools(query); } ``` ### queryPools (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { pools } from '@wix/benefit-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { pools }, // Include the auth strategy and host as relevant }); async function queryPools(query) { const response = await myWixClient.pools.queryPools(query); }; ``` ---