getSiteProperties( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a current snapshot of a site's properties.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Your App
Read site, business, and email details
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function getSiteProperties(): Promise<PropertiesReadResponse>;
Request
This method does not take any parameters
Returns
Return Type:Promise<PropertiesReadResponse>
JavaScript
import { siteProperties } from "@wix/business-tools";

async function getSiteProperties() {
  const response = await siteProperties.getSiteProperties();
}
Errors
401Unauthenticated

There is 1 error with this status code.

403Permission Denied

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?