Search...
Generate a test token to explore our APIs
Get 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.
Authorization
This endpoint requires an authorization header - pass the access token from the OAuth installation flow.
Permissions
This endpoint requires the Manage Your App permission scope.
GET
https://www.wixapis.com/apps/v1/instance
Request
This endpoint does not take any parameters
Response Object
NAME
TYPE
DESCRIPTION
instance
object
Data specific to your app as installed in a specific site.
site
object
Basic data about the site.
Status/Error Codes
The response will include an HTTP status code.
Was this helpful?
Request
curl
Copy Code
1curl -X GET \2 https://www.wixapis.com/apps/v1/instance \3 -H 'Authorization: <AUTH>'
Response
json
1{2 "instance": {3 "appName": "MY_SHINY_APP",4 "appVersion": "0.0.53",5 "billing": {6 "billingCycle": "MONTHLY",7 "packageName": "e8f429d4-0a6a-468f-8044-87f519a53202",8 "source": "Wix discount coupon"9 },10 "instanceId": "07864c16-3a6f-4dd2-9973-028705762b2c",11 "isFree": false,12 "permissions": [13 "WIX_DEVELOPERS.CREATE_CHECKOUT",14 "WIX_DEVELOPERS.MANAGE_APP_INSTANCE",15 "WIX_DEVELOPERS.MANAGE_CHARGE"16 ]17 },18 "site": {19 "locale": "he",20 "multilingual": {21 "isMultiLingual": false,22 "supportedLanguages": []23 },24 "paymentCurrency": "ILS",25 "siteDisplayName": "Mysite 34",26 "url": "https://doereg11.wixsite.com/mysite-34",27 "description": "My awesome site is all about selling stuff",28 "ownerEmail": "site-owner@test.com",29 "ownerInfo": {30 "email": "site-owner@test.com",31 "emailStatus": "VERIFIED_OPT_IN"32 }33 }34}