Migration Rest Portal

Build Apps

Go Headless

Client

API Preview

Develop Websites

REST

GraphQL (Alpha)

options

ListPublishedSiteUrlsOptions

Retrieves a list of a site's published URLs.
If a site hasn't been published, the call returns an empty array.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { site } from '@wix/urls';

const wixClient = createClient({
  modules: { site },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function listPublishedSiteUrls(options) {
  const response = await wixClient.site.listPublishedSiteUrls(options);
}

listPublishedSiteUrls() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { site } from '@wix/urls';

const wixClient = createClient({
  modules: { site },
  auth: dashboard.auth(),
  host: dashboard.host()
  })
});

async function listPublishedSiteUrls(options) {
  const response = await wixClient.site.listPublishedSiteUrls(options);
}

listPublishedSiteUrls() with Dashboard app access

listPublishedSiteUrls

ListPublishedSiteUrlsResponse

# About Published Site URLs
The Published Site URLs API allows you to retrieve links to the published site.  
On occasion, your app might want to direct a site contributor or site visitor to the published site - 
for example, to the site's homepage in Spanish.


## Terminology

- **Published site**: A Wix site that is live and visible to site visitors.
- **Premium**: Wix site builders can pay for Premium plans to unlock additional site tools and features, including connecting their own domains. Read more about [Premium plans](https://support.wix.com/en/article/upgrading-your-site-to-premium-3066683).  
- **Primary URL**: Site builders can connect an unlimited number of domains (URLs) to a single Wix site. The primary URL is the domain that they connect directly to the site and is the site's main URL. 
- **Secondary URL**: When site builders connect additional domains/URLs to a site, they are considered secondary URLs, and will redirect visitors to the  primary URL.
- **Wix Multilingual**: A Wix product that manages site translation. Read more about [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-adding-and-setting-up-wix-multilingual).  


To use the Site API, install the `@wix/urls` package using npm or Yarn:
  ```console
npm install @wix/urls
```

or

```console
yarn add @wix/urls
```

Then import `{ site }` from `@wix/urls`:

```js
import { site } from '@wix/urls'
```
  

urls_site

Filters

Whether to return language subdomains hosted by [Wix Multilingual](https://support.wix.com/article/wix-multilingual-adding-and-setting-up-wix-multilingual). <br /> Default: `true`.

multilingual

boolean

Whether to return only the site's primary URL. <br /> Default: `true`.

primary

URL type filter.

Supported values:
- `ALL`: All URLs.
- `PREMIUM`: Only URLs directing to the Premium version of the site.
- `FREE`: Only URLs including `wixsite.com`.

Default: `ALL`

urlType

UrlTypeFilter

filters

List will be empty for non published sites

urls

MultilingualInfo

Whether this is the site's default language.

defaultLanguage

IETF BCP 47 language tag. For example, `en-US`.

languageCode

string

Language subdomain info hosted by [Wix multilingual](https://support.wix.com/article/wix-multilingual-adding-and-setting-up-wix-multilingual).

multilingualInfo

URL type filter.
Supported values: `ALL`, `PREMIUM`, `FREE`.
Default: `ALL`.

About Published Site URLs

Terminology

Setup

Permission Scopes