> 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 # QueryProgramDefinitions # Package: benefitPrograms # Namespace: ProgramDefinitionService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/program-definitions/query-program-definitions.md ## Permission Scopes: SCOPE.BENEFIT_PROGRAMS.READ (PII): SCOPE.BENEFIT_PROGRAMS.READ_LIMITED ## Introduction Retrieves a list of program definitions, given the provided paging, filtering, and sorting. Query Program Definitions 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/program-definitions/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: queryProgramDefinitions Description: Retrieves a list of program definitions, given the provided paging, filtering, and sorting. Query Program Definitions 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/program-definitions/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/_api/benefit-programs/v1/program-definitions/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: QueryProgramDefinitionsResponse - name: programDefinitions | type: array | description: List of retrieved program definitions. - name: id | type: string | description: Program definition GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the program definition is updated. To prevent conflicting changes, the current revision must be passed when updating the program definition. Ignored when creating a program definition. - name: createdDate | type: string | description: Date and time the program definition was created. - name: updatedDate | type: string | description: Date and time the program definition was updated. - name: displayName | type: string | description: Program definition name. - 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 definition 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 definition defined by you. You can use `externalId` to filter queries. - 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 ### QueryProgramDefinitions ```curl ~~~cURL curl --request POST \ https://www.wixapis.com/benefit-programs/v1/program-definitions/query \ -H 'Authorization: ' \ -H "Content-Type: application/json" \ --data '{ "query": { "filter": { "namespace": { "$eq": "benefit_programs_app" } } } }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.ProgramDefinitionService.queryProgramDefinitions(query) Description: Retrieves a list of program definitions, given the provided paging, filtering, and sorting. Query Program Definitions 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/program-definitions/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: ProgramDefinitionQuery | 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: programDefinitions | type: array | description: List of retrieved program definitions. - name: _id | type: string | description: Program definition GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the program definition is updated. To prevent conflicting changes, the current revision must be passed when updating the program definition. Ignored when creating a program definition. - name: _createdDate | type: Date | description: Date and time the program definition was created. - name: _updatedDate | type: Date | description: Date and time the program definition was updated. - name: displayName | type: string | description: Program definition name. - 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 definition 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 definition defined by you. You can use `externalId` to filter queries. - 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 ### queryProgramDefinitions ```javascript import { programDefinitions } from '@wix/benefit-programs'; async function queryProgramDefinitions(query) { const response = await programDefinitions.queryProgramDefinitions(query); }; ``` ### queryProgramDefinitions (with elevated permissions) ```javascript import { programDefinitions } from '@wix/benefit-programs'; import { auth } from '@wix/essentials'; async function myQueryProgramDefinitionsMethod(query) { const elevatedQueryProgramDefinitions = auth.elevate(programDefinitions.queryProgramDefinitions); const response = await elevatedQueryProgramDefinitions(query); } ``` ### queryProgramDefinitions (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 { programDefinitions } from '@wix/benefit-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { programDefinitions }, // Include the auth strategy and host as relevant }); async function queryProgramDefinitions(query) { const response = await myWixClient.programDefinitions.queryProgramDefinitions(query); }; ``` ---