> 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 # QueryProjects # Package: portfolio # Namespace: ProjectsService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/portfolio/projects/query-projects.md ## Permission Scopes: Manage Portfolio: SCOPE.PORTFOLIO.MANAGE-PORTFOLIO ## Introduction Retrieves a list of projects, given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request. The default `sort` is `id` in `ASC`. To learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md). --- ## REST API ### Schema ``` Method: queryProjects Description: Retrieves a list of projects, given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request. The default `sort` is `id` in `ASC`. To learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md). URL: https://www.wixapis.com/portfolio/projects/projects/api/v1/portfolio/projects/query Method: POST # 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: includePageUrl | type: includePageUrl | description: Whether to include the project's relative path and full URL in the response. Default: `false` param name: query | type: QueryV2 | required: true - ONE-OF: - required: true - name: paging | type: Paging | description: Paging options to limit and offset the number of items. - name: limit | type: integer | description: Number of items to load. - name: offset | type: integer | description: Number of items to skip in the current sort order. - 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 in the results. - 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. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC - name: fields | type: array | description: Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. - name: fieldsets | type: array | description: Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. Return type: QueryProjectsResponse - name: projects | type: array | description: List of projects. - ONE-OF: - name: coverImage | type: Image | description: Project cover image. - name: imageInfo | type: Image | description: Information about the Wix Media image. - name: id | type: string | description: WixMedia image GUID. Required. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image height. Required. - name: width | type: integer | description: Original image width. Required. - name: altText | type: string | description: Image alt text. - name: filename | type: string | description: Image filename. - name: focalPoint | type: Point | description: Focal point of the image. - name: x | type: number | description: X-coordinate of the focal point. - name: y | type: number | description: Y-coordinate of the focal point. - name: coverVideo | type: Video | description: Project cover video. - name: videoInfo | type: VideoV2 | description: Information about the Wix Media video. - name: id | type: string | description: WixMedia GUID. Required. - name: url | type: string | description: Video URL. - name: resolutions | type: array | description: Available resolutions for the video, starting with the optimal resolution. - name: url | type: string | description: Video URL. Required. - name: height | type: integer | description: Video height. Required. - name: width | type: integer | description: Video width. Required. - name: format | type: string | description: Video format for example, mp4, hls. Required. - name: quality | type: string | description: Video quality for example 480p, 720p. - name: filename | type: string | description: Video filename. - name: filename | type: string | description: Video filename. - name: posters | type: array | description: Video posters. - name: durationInMillis | type: integer | description: Manually defined Video duration in milliseconds. - name: id | type: string | description: Project GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object. - name: title | type: string | description: Project title. - name: description | type: string | description: Project description. - name: hidden | type: boolean | description: Whether the project is hidden from the portfolio. Default: `false` - name: collectionIds | type: array | description: IDs of the collections that include the project. - name: details | type: array | description: Project details. - ONE-OF: - name: text | type: string | description: Project label in plain text format. - name: link | type: DetailsLink | description: Project label in link format. - name: text | type: string | description: Display text of the link. - name: url | type: string | description: Target URL of the link. - name: target | type: string | description: Whether the link opens in a new tab or window. One of: * `'_blank'`: The link opens in a new tab or window. * `'_self'`: The link opens in the same tab or window. - name: label | type: string | description: Project label. - name: slug | type: string | description: Project slug. - name: createdDate | type: string | description: Date and time the project was created. - name: updatedDate | type: string | description: Date and time the project was updated. - name: url | type: PageUrlV2 | description: Project page URL and relative path. Returned when `includePageUrl` is `true` in the request. - name: relativePath | type: string | description: The relative path for the page within the site. For example, `/product-page/a-product`. - name: url | type: string | description: The page's full URL. For example, `https://mysite.com/product-page/a-product`. - name: seoData | type: SeoSchema | description: Project SEO data. - name: tags | type: array | description: SEO tag information. - name: type | type: string | description: SEO tag type. Supported values: `title`, `meta`, `script`, `link`. - name: props | type: object | description: A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value. For example: `{"name": "description", "content": "the description itself"}`. - name: meta | type: object | description: SEO tag metadata. For example, `{"height": 300, "width": 240}`. - name: children | type: string | description: SEO tag inner content. For example, ` inner content `. - name: custom | type: boolean | description: Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). - name: disabled | type: boolean | description: Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. - name: settings | type: Settings | description: SEO general settings. - name: preventAutoRedirect | type: boolean | description: Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled. Default: `false` (automatical redirect is enabled). - name: keywords | type: array | description: User-selected keyword terms for a specific page. - name: term | type: string | description: Keyword value. - name: isMain | type: boolean | description: Whether the keyword is the main focus keyword. - name: origin | type: string | description: The source that added the keyword terms to the SEO settings. - name: watermark | type: Watermark | description: Optional watermark that can be applied to all project's images. - name: position | type: Position | description: Position of the watermark on the image. - enum: NORTH_WEST, NORTH, NORTH_EAST, WEST, CENTER, EAST, SOUTH_WEST, SOUTH, SOUTH_EAST - name: size | type: integer | description: Size of the watermark, from 0 to 100. - name: opacity | type: integer | description: Opacity of the watermark. - name: imageUrl | type: string | description: Image GUID of the Watermark as saved in Media Platform. - name: enabled | type: boolean | description: Whether the watermark is to be displayed on Items & Cover Photos. - name: metadata | type: PagingMetadataV2 | description: Paging metadata. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - 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. ``` ### Examples ### Query Projects ```curl curl -X POST \ 'https://www.wixapis.com/portfolio/v1/projects/query' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "query": { "filter": { "title": { "$contains": "Project" } }, "sort": [ { "fieldName": "createdDate", "order": "ASC" } ], "cursorPaging": { "limit": 10 } }, "includePageUrl": true }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.portfolio.ProjectsService.queryProjects(query, options) Description: Retrieves a list of projects, given the provided paging, filtering, and sorting. Up to 100 projects can be returned per request. The default `sort` is `id` in `ASC`. To learn how to query projects, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md). # 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: options | type: QueryProjectsOptions none - name: includePageUrl | type: boolean | description: Whether to include the project's relative path and full URL in the response. Default: `false` param name: query | type: ProjectQuery | required: true - ONE-OF: - required: true - name: paging | type: Paging | description: Paging options to limit and offset the number of items. - name: limit | type: integer | description: Number of items to load. - name: offset | type: integer | description: Number of items to skip in the current sort order. - 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 in the results. - 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. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: PROMISE - name: projects | type: array | description: List of projects. - ONE-OF: - name: coverImage | type: Image | description: Project cover image. - name: imageInfo | type: string | description: Information about the Wix Media image. - name: focalPoint | type: Point | description: Focal point of the image. - name: x | type: number | description: X-coordinate of the focal point. - name: y | type: number | description: Y-coordinate of the focal point. - name: coverVideo | type: Video | description: Project cover video. - name: videoInfo | type: string | description: Information about the Wix Media video. - name: durationInMillis | type: integer | description: Manually defined Video duration in milliseconds. - name: _id | type: string | description: Project GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object. - name: title | type: string | description: Project title. - name: description | type: string | description: Project description. - name: hidden | type: boolean | description: Whether the project is hidden from the portfolio. Default: `false` - name: collectionIds | type: array | description: IDs of the collections that include the project. - name: details | type: array | description: Project details. - ONE-OF: - name: text | type: string | description: Project label in plain text format. - name: link | type: DetailsLink | description: Project label in link format. - name: text | type: string | description: Display text of the link. - name: url | type: string | description: Target URL of the link. - name: target | type: string | description: Whether the link opens in a new tab or window. One of: * `'_blank'`: The link opens in a new tab or window. * `'_self'`: The link opens in the same tab or window. - name: label | type: string | description: Project label. - name: slug | type: string | description: Project slug. - name: _createdDate | type: Date | description: Date and time the project was created. - name: _updatedDate | type: Date | description: Date and time the project was updated. - name: url | type: string | description: Project page URL and relative path. Returned when `includePageUrl` is `true` in the request. - name: seoData | type: SeoSchema | description: Project SEO data. - name: tags | type: array | description: SEO tag information. - name: type | type: string | description: SEO tag type. Supported values: `title`, `meta`, `script`, `link`. - name: props | type: object | description: A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value. For example: `{"name": "description", "content": "the description itself"}`. - name: meta | type: object | description: SEO tag metadata. For example, `{"height": 300, "width": 240}`. - name: children | type: string | description: SEO tag inner content. For example, ` inner content `. - name: custom | type: boolean | description: Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). - name: disabled | type: boolean | description: Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. - name: settings | type: Settings | description: SEO general settings. - name: preventAutoRedirect | type: boolean | description: Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled. Default: `false` (automatical redirect is enabled). - name: keywords | type: array | description: User-selected keyword terms for a specific page. - name: term | type: string | description: Keyword value. - name: isMain | type: boolean | description: Whether the keyword is the main focus keyword. - name: origin | type: string | description: The source that added the keyword terms to the SEO settings. - name: watermark | type: Watermark | description: Optional watermark that can be applied to all project's images. - name: position | type: Position | description: Position of the watermark on the image. - enum: NORTH_WEST, NORTH, NORTH_EAST, WEST, CENTER, EAST, SOUTH_WEST, SOUTH, SOUTH_EAST - name: size | type: integer | description: Size of the watermark, from 0 to 100. - name: opacity | type: integer | description: Opacity of the watermark. - name: imageUrl | type: string | description: Image GUID of the Watermark as saved in Media Platform. - name: enabled | type: boolean | description: Whether the watermark is to be displayed on Items & Cover Photos. - name: metadata | type: PagingMetadataV2 | description: Paging metadata. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - 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. ``` ### Examples ### queryProjects ```javascript import { projects } from '@wix/portfolio'; async function queryProjects(query,options) { const response = await projects.queryProjects(query,options); }; ``` ### queryProjects (with elevated permissions) ```javascript import { projects } from '@wix/portfolio'; import { auth } from '@wix/essentials'; async function myQueryProjectsMethod(query,options) { const elevatedQueryProjects = auth.elevate(projects.queryProjects); const response = await elevatedQueryProjects(query,options); } ``` ### queryProjects (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 { projects } from '@wix/portfolio'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { projects }, // Include the auth strategy and host as relevant }); async function queryProjects(query,options) { const response = await myWixClient.projects.queryProjects(query,options); }; ``` ---