> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListAppPermissions # Package: appPermissions # Namespace: AppPermissionsService # Method link: https://dev.wix.com/docs/api-reference/app-management/app-permissions/list-app-permissions.md ## Introduction Lists all permissions for the specified app. These are the permissions your app requests when users install it on a site. --- ## REST API ### Schema ``` Method: listAppPermissions Description: Lists all permissions for the specified app. These are the permissions your app requests when users install it on a site. URL: https://www.wixapis.com/apps/v1/app-permissions Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: appId Method parameters: query param name: appId | type: appId | description: App GUID. You can find the app GUID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard. | required: true query param name: consistent | type: consistent | description: Whether to retrieve the most recent permissions information. This decreases performance but ensures that the retrieved information is up-to-date, even immediately after an update. Default: `false`. param name: paging | type: CursorPaging - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. Return type: ListAppPermissionsResponse - name: appPermissions | type: array | description: List of permissions for the specified app. - name: appId | type: string | description: App GUID. You can find the app GUID in the app's dashboard's [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home). - name: permission | type: Permission | description: Permission the app requests when installed on a site. Learn more [about permissions for Wix apps](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions.md). - name: permissionId | type: string | description: Permission GUID. To find the permission GUID, navigate to the [Permissions page](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fdev-center-permissions/add) in the app's dashboard and search for the [permission you want to configure](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app.md#step-1--identify-required-permissions). - name: createdDate | type: string | description: When the permission was created. - name: updatedDate | type: string | description: When the permission was last updated. - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### List an app's permissions ```curl curl -X GET \ 'https://www.wixapis.com/apps/v1/app-permissions/v1/app-permissions?appId=73k98f4e-a8f3-4b7c-9d87-23fc55g793ec&consistent' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.appPermissions.AppPermissionsService.listAppPermissions(appId, options) Description: Lists all permissions for the specified app. These are the permissions your app requests when users install it on a site. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: appId Method parameters: param name: appId | type: string | description: App GUID. You can find the app GUID on the [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home) in the app's dashboard. | required: true param name: options | type: ListAppPermissionsOptions none - name: consistent | type: boolean | description: Whether to retrieve the most recent permissions information. This decreases performance but ensures that the retrieved information is up-to-date, even immediately after an update. Default: `false`. - name: paging | type: CursorPaging | description: Paging configuration. - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. Return type: PROMISE - name: appPermissions | type: array | description: List of permissions for the specified app. - name: appId | type: string | description: App GUID. You can find the app GUID in the app's dashboard's [Home page](https://manage.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%home). - name: permission | type: Permission | description: Permission the app requests when installed on a site. Learn more [about permissions for Wix apps](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions.md). - name: permissionId | type: string | description: Permission GUID. To find the permission GUID, navigate to the [Permissions page](https://dev.wix.com/app-selector?title=Select+an+App&primaryButtonText=Select+Site&actionUrl=https%3A%2F%2Fdev.wix.com%2Fapps%2F%7BappId%7D%2Fdev-center-permissions/add) in the app's dashboard and search for the [permission you want to configure](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app.md#step-1--identify-required-permissions). - name: _createdDate | type: Date | description: When the permission was created. - name: _updatedDate | type: Date | description: When the permission was last updated. - name: pagingMetadata | type: CursorPagingMetadata | description: Paging metadata. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### listAppPermissions ```javascript import { appPermissions } from '@wix/app-management'; async function listAppPermissions(appId,options) { const response = await appPermissions.listAppPermissions(appId,options); }; ``` ### listAppPermissions (with elevated permissions) ```javascript import { appPermissions } from '@wix/app-management'; import { auth } from '@wix/essentials'; async function myListAppPermissionsMethod(appId,options) { const elevatedListAppPermissions = auth.elevate(appPermissions.listAppPermissions); const response = await elevatedListAppPermissions(appId,options); } ``` ### listAppPermissions (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { appPermissions } from '@wix/app-management'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { appPermissions }, // Include the auth strategy and host as relevant }); async function listAppPermissions(appId,options) { const response = await myWixClient.appPermissions.listAppPermissions(appId,options); }; ``` ---