About This API

This API exposes basic data about the user's site and the app installed in it, as based on the user's authentication token.
When you provide the authentication token, you will receive identifying information for the user's site and the app instance parameters.
The primary identifier returned is the App Instance ID - the unique identifier of the app within the website. Using the App Instance ID, you can retrieve data about the site that installed the app (e.g., locale) and data about the app installed (e.g., current paid plan).

Was this helpful?
Yes
No

App Instance Object

Attributes
instanceIdstring
App instance ID - a unique ID assigned to each app in each site.

appNamestring
App name.

appVersionstring
App version installed in this instance.

isFreeboolean
Whether the site owner has a free version of the app (and no paid plan is found). Otherwise false.

billingobject
Billing info for the purchased app/plan in this site. Returned only when isFree is false.

permissionsArray <string>
Permissions included in this app's access token.

availablePlansArray <AvailablePlan>
Plans available to this instance.

originInstanceIdstring
This is the instance ID of a site that is being cloned. All visual settings and app data are duplicated, and the developer should be notified to take actions related to any external functionality that may have been added to the original site.

isOriginSiteTemplateboolean
Deprecation Notice: This parameter will be removed on March 30, 2023. Use copiedFromTemplate instead.;

copiedFromTemplateboolean
If the app was installed when cloning a site from a template.
Was this helpful?
Yes
No

GetGet App Instance

Retrieves data about the installation of your app on the user's website. The ownerInfo object requires the Read Site Owner Email permission scope. If the permission is not requested, ownerInfo is not returned.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Your App
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/apps/v1/instance

Was this helpful?
Yes
No

Instance App Installed

When you sign up for the App Installed webhook, you will receive this notification when your app is installed on a site

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
appIdstring
Unique identifier of the app within the website.

originInstanceIdstring
Instance ID of the app in the original website (relevant only when this site was duplicated from another site).
Was this helpful?
Yes
No

Instance App Removed

When you sign up for the App Removed webhook, you will receive this notification when your app is uninstalled from a site

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
appIdstring
Unique identifier of the app within the website.
Was this helpful?
Yes
No