Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Frontend Modules

Wix Design System (WDS)

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

value

BoolValue

Int32Value

StringValue

GetSiteUrlRequest

Base URL of the site. It doesn't end with a slash, and a free Wix site includes the site name as a sub-path. For example, `https://www.example.com` or `https://username.wixsite.com/mysite`.
For a site that isn't published, it's the free URL that the site gets when it's published.

To build a page URL, append the page's `path`, which always starts with `/`.

baseUrl

Whether the site is published. If `false`, the item pages of dynamic pages aren't available yet, and page URLs can't be reached by visitors yet.

published

GetSiteUrlResponse

Request to list the item pages of a dynamic page.

`id` of the dynamic page, as [List Dynamic Pages](https://dev.wix.com/docs/api-reference/assets/rich-content/site-context-v1/list-dynamic-pages) returns it. It's not the `id` of an item page.
Several dynamic pages can share the same `prefix`, because the page that lists the items and the template of the item pages of one collection use the same prefix.
Specify `pageId` to list only the item pages of that dynamic page. If you omit it, the item pages of all dynamic pages with this `prefix` are returned.
If `pageId` isn't the `id` of a dynamic page with this `prefix`, no item pages are returned.

pageId

Cursor paging options.

Default: `paging.limit` is `50`.

`path` of the dynamic page, as [List Dynamic Pages](https://dev.wix.com/docs/api-reference/assets/rich-content/site-context-v1/list-dynamic-pages) returns it. For example, `/items`. A value without the leading `/` is also accepted.

prefix

ListDynamicItemPagesRequest

items

Paging metadata. To retrieve the next page of results, specify `cursors.next` in `paging.cursor`.

Whether the site is published. If `false`, item pages aren't available yet, and page URLs can't be reached by visitors yet.

ListDynamicItemPagesResponse

Request to list the dynamic pages of the site.

ListDynamicPagesRequest

Paging metadata. All dynamic pages are returned in one response, so `hasNext` is always `false`.

Whether the site is published. If `false`, page URLs can't be reached by visitors yet.

ListDynamicPagesResponse

Request to list the static pages of the site.

ListStaticPagesRequest

ListStaticPagesResponse

A placeholder entity of the Ricos site context service.

RicosSiteContextPlaceholder

A site page is a page of the current Wix site that rich content can link to. It's a static page, a dynamic page that generates one page for each item of a collection, or one of the item pages of a dynamic page.

Whether the dynamic page is the template of the item pages, as opposed to the page that lists the items.
Returned only for dynamic pages. `false` is also returned for a dynamic page that has no item pages.
If the site isn't published, item pages aren't available yet.

hasItemPages

Page ID of a static page or a dynamic page.
For an item page, this is an opaque key that identifies the item page. It isn't a page ID or a collection item ID, so don't specify it as `pageId` in [List Dynamic Item Pages](https://dev.wix.com/docs/api-reference/assets/rich-content/site-context-v1/list-dynamic-item-pages), and don't parse it.

Path of the page within the site. Store `path`, not `url`, as the link target, because it doesn't depend on the site's domain.

Always starts with `/`. For example:
+ Static page: includes the paths of the parent pages. For example, `/about/team`.
+ Dynamic page: the path shared by its item pages. For example, `/items`.
+ Item page: the dynamic page's path followed by the item's path. For example, `/items/first-item`.

path

Page title. For an item page, the name of the item. Empty if the item has no name.

title

Full URL of the page: the site's base URL followed by `path`. Use it to display or preview the link, but don't store it.

SitePage

Cursor-based pagination parameters for listing requests.

Cursor token for pagination. Use the cursor from the previous response to get the next page of results.

cursor

limit

CursorPaging

Pagination metadata returned with list responses.

Number of items returned in the current response.

count

Navigation cursors for moving between result pages.

Whether there are more pages to retrieve following the current page.

hasNext

CursorPagingMetadata

Cursor for retrieving the next page of results.

Cursors

Retrieves the base URL of the current site and whether the site is published.

Use the base URL to build page URLs for display: `baseUrl` followed by the page's `path`. To match an older link that was stored as a full URL, remove the base URL from it to get the `path`.

To list the pages of the site, call [List Static Pages](https://dev.wix.com/docs/api-reference/assets/rich-content/site-context-v1/list-static-pages), [List Dynamic Pages](https://dev.wix.com/docs/api-reference/assets/rich-content/site-context-v1/list-dynamic-pages) and [List Dynamic Item Pages](https://dev.wix.com/docs/api-reference/assets/rich-content/site-context-v1/list-dynamic-item-pages).

Retrieves the base URL of the site and whether it's published

Get site URL

GetSiteUrl

Read Site Context for Rich Content

Lists the static pages of the current site, sorted by title, with cursor paging.

Returned pages:
+ The home page.
+ Pages that no Wix app manages.
+ Pages of Wix apps with these page intents: `shopping_cart`, `wix-referrals-refer-friend`, `Event List`, `Schedule`, `blog`, `all_members`, `groups`, `Challenges`, `wix_file_share_page`, `Menus`, `bookings_list`, `menu-orders-page-48605ac5-53fc-49b4-96b2-87f7636f5ce0` and `Loyalty`.

Other pages of Wix apps aren't returned. Pages aren't filtered by whether they're hidden, password-protected or restricted to site members.

To retrieve the next page of results, specify `pagingMetadata.cursors.next` from the previous response in `paging.cursor`.

The paging cursor is invalid or expired. Start again without a cursor.

Retrieves the static pages of the site and paginates through the results

List static pages

ListStaticPages

Lists the dynamic pages of the current site, in the order the site stores them. Only dynamic pages of Wix Data collections, and dynamic pages that no Wix app manages, are returned. All pages are returned in one response, without paging.

A dynamic page is a page template that generates one page for each item of a collection. Each page indicates whether it's the template of the item pages (`hasItemPages`). To list the item pages of a dynamic page, call [List Dynamic Item Pages](https://dev.wix.com/docs/api-reference/assets/rich-content/site-context-v1/list-dynamic-item-pages).

List dynamic pages

ListDynamicPages

Lists the item pages of a dynamic page, with cursor paging.

Specify the `path` of a dynamic page that [List Dynamic Pages](https://dev.wix.com/docs/api-reference/assets/rich-content/site-context-v1/list-dynamic-pages) returns as `prefix`, and its `id` as `pageId`.

Item pages are read from the published version of the site. The method doesn't check that the site is published. Check the `published` field of the response.

The method doesn't validate `prefix` or `pageId`. If they don't match a dynamic page of the site, no item pages are returned and the call doesn't fail.

Retrieves the item pages of a dynamic page