Skip to content

spo field get

Retrieves information about the specified list- or site column

Usage

m365 spo field get [options]

Options

-u, --webUrl <webUrl>
Absolute URL of the site where the field is located
-l, --listTitle [listTitle]
Title of the list where the field is located. Specify only one of listTitle, listId or listUrl
--listId [listId]
ID of the list where the field is located. Specify only one of listTitle, listId or listUrl
--listUrl [listUrl]
Server- or web-relative URL of the list where the field is located. Specify only one of listTitle, listId or listUrl
-i, --id [id]
The ID of the field to retrieve. Specify id or fieldTitle but not both
--fieldTitle [fieldTitle]
The display name (case-sensitive) of the field to retrieve. Specify id or fieldTitle but not both
-h, --help
output usage information
--query [query]
JMESPath query string. See http://jmespath.org/ for more information and examples
-o, --output [output]
Output type. json,text. Default text
--verbose
Runs command with verbose logging
--debug
Runs command with debug logging

Examples

Retrieves site column by id located in site https://contoso.sharepoint.com/sites/contoso-sales

m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b

Retrieves list column by id located in site https://contoso.sharepoint.com/sites/contoso-sales. Retrieves the list by its title

m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b

Retrieves list column by display name located in site https://contoso.sharepoint.com/sites/contoso-sales. Retrieves the list by its url

m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl 'Lists/Events' --fieldTitle 'Title'