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

Request
This endpoint does not take any parameters.
Response Object
instanceInstance

Retrieved app instance.


siteSite

Information about the site.

Get App Instance Example 1
Request
cURL
curl -X GET \ https://www.wixapis.com/apps/v1/instance \ -H 'Authorization: <AUTH>'
Response
JSON
{ "instance": { "appName": "MY_SHINY_APP", "appVersion": "0.0.53", "billing": { "billingCycle": "MONTHLY", "packageName": "e8f429d4-0a6a-468f-8044-87f519a53202", "source": "Wix discount coupon" }, "instanceId": "07864c16-3a6f-4dd2-9973-028705762b2c", "isFree": false, "permissions": [ "WIX_DEVELOPERS.CREATE_CHECKOUT", "WIX_DEVELOPERS.MANAGE_APP_INSTANCE", "WIX_DEVELOPERS.MANAGE_CHARGE" ] }, "site": { "locale": "he", "multilingual": { "isMultiLingual": false, "supportedLanguages": [] }, "paymentCurrency": "ILS", "siteDisplayName": "Mysite 34", "url": "https://doereg11.wixsite.com/mysite-34", "description": "My awesome site is all about selling stuff", "ownerEmail": "site-owner@test.com", "ownerInfo": { "email": "site-owner@test.com", "emailStatus": "VERIFIED_OPT_IN" }, "siteId": "64fc2d7e-1585-45ef-b1c3-6081185108c1" } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?