> 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 # QueryPrograms # Package: benefitPrograms # Namespace: ProgramService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/programs/query-programs.md ## Permission Scopes: SCOPE.BENEFIT_PROGRAMS.READ (PII): SCOPE.BENEFIT_PROGRAMS.READ_LIMITED ## Introduction Retrieves a list of programs, given the provided paging, filtering, and sorting. Query Programs 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/programs/filtering-and-sorting.md). To learn how to query program definitions, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). --- ## REST API ### Schema ``` Method: queryPrograms Description: Retrieves a list of programs, given the provided paging, filtering, and sorting. Query Programs 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/programs/filtering-and-sorting.md). To learn how to query program definitions, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). URL: https://www.wixapis.com/benefit-programs/v1/programs/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: QueryProgramsResponse - name: programs | type: array | description: List of retrieved programs. - name: id | type: string | description: Program GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current revision must be specified when updating the program. Ignored when creating a program. - name: createdDate | type: string | description: Date and time the program was created. - name: updatedDate | type: string | description: Date and time the program was updated. - name: programDefinitionId | type: string | description: GUID of the associated program definition. - name: status | type: ProgramStatus | description: Program status. - enum: - ACTIVE: Program is active. - PAUSED: Program is paused. It can be resumed. - ENDED: Program has ended. It can't be resumed. - PROVISIONING: Program is being activated for the first time. This status exists for a short time during processing. - PAUSING: Program is being paused. This status exists for a short time during processing. - RESUMING: Program is being re-activated after being paused. This status exists for a short time during processing. - ENDING: Program is being ended. This status exists for a short time during processing. - name: beneficiary | type: IdentificationData | description: Program 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: displayName | type: string | description: Program name. You may want to use the same name that's used in the associated program definition, if it exists. - 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 program 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: externalId | type: string | description: GUID for the program defined by you. You can use `externalId` to filter queries. - 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: 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 ### QueryPrograms ```curl ~~~cURL curl --request POST https://www.wixapis.com/benefit-programs/v1/programs/query \ -H "Authorization: " \ -H "Content-Type: application/json" \ --data '{ "query": { "filter": { "externalId": { "$eq": "90000000-0000-0000-0000-000000000000" } } } }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.ProgramService.queryPrograms(query) Description: Retrieves a list of programs, given the provided paging, filtering, and sorting. Query Programs 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/programs/filtering-and-sorting.md). To learn how to query program definitions, 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: ProgramQuery | 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: programs | type: array | description: List of retrieved programs. - name: _id | type: string | description: Program GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current revision must be specified when updating the program. Ignored when creating a program. - name: _createdDate | type: Date | description: Date and time the program was created. - name: _updatedDate | type: Date | description: Date and time the program was updated. - name: programDefinitionId | type: string | description: GUID of the associated program definition. - name: status | type: ProgramStatus | description: Program status. - enum: - ACTIVE: Program is active. - PAUSED: Program is paused. It can be resumed. - ENDED: Program has ended. It can't be resumed. - PROVISIONING: Program is being activated for the first time. This status exists for a short time during processing. - PAUSING: Program is being paused. This status exists for a short time during processing. - RESUMING: Program is being re-activated after being paused. This status exists for a short time during processing. - ENDING: Program is being ended. This status exists for a short time during processing. - name: beneficiary | type: IdentificationData | description: Program 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: displayName | type: string | description: Program name. You may want to use the same name that's used in the associated program definition, if it exists. - 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 program 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: externalId | type: string | description: GUID for the program defined by you. You can use `externalId` to filter queries. - 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: 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 ### Query benefit programs ```javascript import { programs } from "@wix/benefit-programs"; async function queryPrograms() { const response = await programs.queryPrograms({ filter: { externalId: "90000000-0000-0000-0000-000000000000" }, }); } /* Promise resolves to: * { * "programs": [{ "id": "...", "status": "ACTIVE", "externalId": "myProgram17" }], * "metadata": { "count": 1, "hasNext": false } * } */ ``` ### queryPrograms (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 { programs } from '@wix/benefit-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { programs }, // Include the auth strategy and host as relevant }); async function queryPrograms(query) { const response = await myWixClient.programs.queryPrograms(query); }; ``` ---