Get

Get App Instance


Retrieves data about the instance of your app that's installed on a Wix site and data about the site itself.

Call this endpoint 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 an App Instance. This also provides the API with the details of the site that's making the call.

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.
Endpoint
GET
https://www.wixapis.com/apps/v1/instance

Was this helpful?
Yes
No