Skip to content

spo app get

Gets information about the specific app from the specified app catalog

Usage

m365 spo app get [options]

Options

-i, --id [id]
ID of the app to retrieve information for. Specify the id or the name but not both
-n, --name [name]
Name of the app to retrieve information for. Specify the id or the name but not both
-u, --appCatalogUrl [appCatalogUrl]
URL of the tenant or site collection app catalog. It must be specified when the scope is sitecollection
-s, --appCatalogScope [appCatalogScope]
Scope of the app catalog: tenant,sitecollection. Default tenant
-h, --help [help]
Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is full.
--query [query]
JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
Output type. json,text,csv,md. Default json
--verbose
Runs command with verbose logging
--debug
Runs command with debug logging

Remarks

When getting information about an app from the tenant app catalog, it's not necessary to specify the tenant app catalog URL. When the URL is not specified, the CLI will try to resolve the URL itself. Specifying the app catalog URL is required when you want to get information about an app from a site collection app catalog.

When specifying site collection app catalog, you can specify the URL either with our without the AppCatalog part, for example https://contoso.sharepoint.com/sites/team-a/AppCatalog or https://contoso.sharepoint.com/sites/team-a. CLI will accept both formats.

Examples

Return details about the app with ID b2307a39-e878-458b-bc90-03bc578531d6 available in the tenant app catalog.

m365 spo app get --id b2307a39-e878-458b-bc90-03bc578531d6

Return details about the app with name solution.sppkg available in the tenant app catalog. Will try to detect the app catalog URL

m365 spo app get --name solution.sppkg

Return details about the app with name solution.sppkg available in the tenant app catalog using the specified app catalog URL

m365 spo app get --name solution.sppkg --appCatalogUrl https://contoso.sharepoint.com/sites/apps

Return details about the app with ID b2307a39-e878-458b-bc90-03bc578531d6 available in the site collection app catalog of site https://contoso.sharepoint.com/sites/site1.

m365 spo app get --id b2307a39-e878-458b-bc90-03bc578531d6 --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1

More information