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 site properties

The getSiteProperties() function returns a promise that resolves to the site properties.

Admin Method

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Your App
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
optionsGetSitePropertiesOptions

Field options.

Returns
Return Type:Promise<PropertiesReadResponse>
Was this helpful?
Yes
No