Skip to main content

spo field list

Retrieves columns for the specified list or site

Usage​

m365 spo field list [options]

Options​

-u, --webUrl <webUrl>

Absolute URL of the site where fields are located.

-t, --listTitle [listTitle]

Title of the list where fields are located. Specify either listTitle, listId or listUrl.

-i --listId [listId]

ID of the list where fields are located. Specify either listTitle, listId or listUrl.

--listUrl [listUrl]

Server- or web-relative URL of the list where fields are located. Specify either listTitle, listId or listUrl.

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

Examples​

Retrieves site columns for the specified site.

m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales

Retrieves list columns for list Events in the specified site.

m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events

Retrieves list columns for the specified list in the specified site.

m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'

Retrieves list columns for the specified list in the specified site.

m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'

Response​

[
  {
    "AutoIndexed": false,
    "CanBeDeleted": true,
    "ClientSideComponentId": "00000000-0000-0000-0000-000000000000",
    "ClientSideComponentProperties": null,
    "ClientValidationFormula": null,
    "ClientValidationMessage": null,
    "CustomFormatter": null,
    "DefaultFormula": null,
    "DefaultValue": "[today]",
    "Description": "",
    "Direction": "none",
    "EnforceUniqueValues": false,
    "EntityPropertyName": "PnPAlertStartDateTime",
    "Filterable": true,
    "FromBaseType": false,
    "Group": "PnP Columns",
    "Hidden": false,
    "Id": "5ee2dd25-d941-455a-9bdb-7f2c54aed11b",
    "Indexed": false,
    "IndexStatus": 0,
    "InternalName": "PnPAlertStartDateTime",
    "IsModern": false,
    "JSLink": "clienttemplates.js",
    "PinnedToFiltersPane": false,
    "ReadOnlyField": false,
    "Required": false,
    "SchemaXml": "<Field Type=\"DateTime\" DisplayName=\"Start date-time\" Required=\"FALSE\" EnforceUniqueValues=\"FALSE\" Indexed=\"FALSE\" Format=\"DateTime\" Group=\"PnP Columns\" FriendlyDisplayFormat=\"Disabled\" ID=\"{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}\" SourceID=\"{4f118c69-66e0-497c-96ff-d7855ce0713d}\" StaticName=\"PnPAlertStartDateTime\" Name=\"PnPAlertStartDateTime\" Version=\"1\"><Default>[today]</Default></Field>",
    "Scope": "/sites/SPDemo",
    "Sealed": false,
    "ShowInFiltersPane": 0,
    "Sortable": true,
    "StaticName": "PnPAlertStartDateTime",
    "Title": "Start date-time",
    "FieldTypeKind": 4,
    "TypeAsString": "DateTime",
    "TypeDisplayName": "Date and Time",
    "TypeShortDescription": "Date and Time",
    "ValidationFormula": null,
    "ValidationMessage": null,
    "DateTimeCalendarType": 0,
    "DateFormat": null,
    "DisplayFormat": 1,
    "FriendlyDisplayFormat": 1,
    "TimeFormat": null
  }
]
CTRL + M