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

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Your App
Read site, business, and email details
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsGetSitePropertiesOptions

Field options.

Returns
Return Type:Promise<PropertiesReadResponse>
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?