Skip to main content

spo sitescript get

Gets information about the specified site script

Usage

m365 spo sitescript get [options]

Options

-i, --id <id>

Site script ID.

-c, --content

Specify to only retrieve the content of the site script.

-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 options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Remarks

If the specified id doesn't refer to an existing site script, you will get a File not found error.

Examples

Get information about the site script with the specified ID.

m365 spo sitescript get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a

Returns the site script contents:

m365 spo sitescript get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --content

Response

Standard response

{
"Content": "{\"$schema\":\"https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json\",\"actions\":[{\"verb\":\"activateSPFeature\",\"name\":\"SiteNotebook feature\",\"title\":\"SiteNotebook feature\",\"featureId\":\"f151bb39-7c3b-414f-bb36-6bf18872052f\",\"scope\":\"web\"}],\"bindata\":{},\"version\":1}",
"ContentByteArray": null,
"Description": "Contoso site script",
"Id": "43d4ffa0-c7ee-4a97-91d7-db27e5b62de5",
"IsSiteScriptPackage": false,
"Title": "Contoso",
"Version": 1
}

content response

When we make use of the option content the response will differ.

{ 
"$schema": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json",
"actions": [
{
"verb":"activateSPFeature",
"name": "SiteNotebook feature",
"title": "SiteNotebook feature",
"featureId": "f151bb39-7c3b-414f-bb36-6bf18872052f",
"scope": "web"
}
],
"bindata":{},
"version":1
}

More information

CTRL + M