Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token
from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.

cursor

Number of domains to load.

Min: `0`
Max: `100`

limit

CursorPaging

Number of domains returned in the response.

count

Indicates if there are more results after the current page.
If `true`, another page of results can be retrieved.
If `false`, this is the last page.

hasNext

CursorPagingMetadata

Cursor pointing to next page in the list of results.

Cursors

AssignmentType

A `connectedDomain` object holds information about an external domain and its connection to a Wix site.

How the domain is connected to the Wix site.

+ `"UNKNOWN_CONNECTION_TYPE"`: There is no information about the connection type.
+ `"POINTING"`: The domain is connected by pointing. Wix doesn't manage DNS information.
+ `"NAMESERVERS"`: The domain is connected by nameservers. Wix manages DNS information.
+ `"HIDDEN"`: The domain isn't visible to site visitors.

connectionType

DNS propagation status.

+ `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
+ `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
+ `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
+ `"FAILED"`: The domain's DNS propagation process has failed.

dnsPropagationStatus

Domain name including TLD.
Both root domains and subdomains are supported.

domain

ID of the connected domain. Identical to the domain name including TLD.

Information about the site to which the domain is assigned to and whether
it's the primary domain or a redirect.

Whether the site owner receives standard email notifications from Wix about
the connected domain.

Default: `false`

suppressNotifications

ConnectedDomain

ConnectionType

CreateConnectedDomainRequest

CreateConnectedDomainResponse

ID of the connected domain to delete. Identical to the domain name including TLD.

connectedDomainId

DeleteConnectedDomainRequest

DeleteConnectedDomainResponse

DnsPropagationStatus

GetConnectedDomainRequest

GetConnectedDomainResponse

ListConnectedDomainsRequest

connectedDomains

Metadata about the returned list of connected domains.

ListConnectedDomainsResponse

Whether the domain is assigned as primary domain or redirect.
Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).

+ `"UNKNOWN_ASSIGNMENT_TYPE"`: There's no information about the assignment type.
+ `"PRIMARY"`: The domain is assigned as the primary domain to the Wix site.
+ `"REDIRECT"`: The domain is assigned as a redirect to the Wix site.

assignmentType

ID of the site the domain is assigned to.

SiteInfo

value

BoolValue

Int32Value

StringValue

Retrieves a list of up to 100 connected domains.


You must pass the relevant Wix account ID in the header of the call.

The retrieved domains are sorted by `createdDate` in descending order.

> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.

Manage Domains

Retrieve a list of connected domains.

ListConnectedDomains

paging

Creates a `connectedDomain` object and starts the domain connection process.
It may take up to 48 hours for the DNS changes to take effect.


You must pass the relevant Wix account ID in the header of the call.
You may also pass a Wix site ID in the header.

You can only connect external domains using this endpoint. Domains purchased
and billed through Wix can't be connected via this endpoint to a Wix site. For those
domains use the [Registered Domains API](https://dev.wix.com/docs/rest/api-reference/account-level-ap-is/registered-domains/introduction)
instead.

You can connect both root domains and subdomains to Wix sites.

The domain can be assigned as a primary domain or a redirect.
You can read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
If you connect a domain as `"PRIMARY"` to a Wix site, the existing primary
domain automatically becomes unassigned.

> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.

Connect a subdomain

CreateConnectedDomain

Connect a domain using nameservers

Connect a domain by pointing

Retrieves a connected domain.


You must pass the relevant Wix account ID in the header of the call.

> __Important:__ This call requires an account level API key and cannot be authenticated with the standard authorization header.

List Connected Domains

Permission Scopes