getAppInstance( )


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 data about the instance of your app that's installed on a Wix site and data about the site itself. For example, to check whether the Wix user has installed a free or paid version of your app, or to check which apps made by Wix are installed on the site.

You must authenticate this method as a Wix app (REST | SDK).

To retrieve site.ownerInfo in the response, you must have the READ SITE OWNER EMAIL permission scope in addition to MANAGE YOUR APP.

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
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<GetAppInstanceResponse>
Did this help?