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.

Call this function when you need information about a specific instance of your app and the site it’s installed on. For example, you may need to know whether the user has installed a free or paid version of your app, or to check what other Wix apps are installed on the site.

You must authenticate as a Wix App. If you are calling this function from a dashboard extension in the CLI, Wix App authentication is passed automatically. Otherwise, you need to call the function with elevated permissions.

If you want site.ownerInfo to be included in the response, you must have the Read Site Owner Email permission scope in addition to WIX_DEVELOPERS.MANAGE_APP_INSTANCE.

Authentication

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

Permissions
Manage Your App
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Return Type:Promise<GetAppInstanceResponse>
Was this helpful?
Yes
No