Get-PnPListItem
SYNOPSIS
Retrieves list items
SYNTAX
All Items (Default)
Get-PnPListItem [-List] <ListPipeBind> [-FolderServerRelativeUrl <String>] [-Fields <String[]>]
[-PageSize <Int32>] [-ScriptBlock <ScriptBlock>] [-IncludeContentType <SwitchParameter>] [-Connection <PnPConnection>]
By Id
Get-PnPListItem [-List] <ListPipeBind> [-Id <Int32>] [-Fields <String[]>] [-IncludeContentType <SwitchParameter>]
[-Connection <PnPConnection>]
By Unique Id
Get-PnPListItem [-List] <ListPipeBind> [-UniqueId <Guid>] [-Fields <String[]>] [-IncludeContentType <SwitchParameter>] [-Connection <PnPConnection>]
By Query
Get-PnPListItem [-List] <ListPipeBind> [-Query <String>] [-FolderServerRelativeUrl <String>]
[-PageSize <Int32>] [-IncludeContentType <SwitchParameter>] [-ScriptBlock <ScriptBlock>] [-Connection <PnPConnection>]
DESCRIPTION
Allows to retrieve list items.
EXAMPLES
EXAMPLE 1
Get-PnPListItem -List Tasks
Retrieves all list items from the Tasks list
EXAMPLE 2
Get-PnPListItem -List Tasks -Id 1
Retrieves the list item with ID 1 from the Tasks list
EXAMPLE 3
Get-PnPListItem -List Tasks -UniqueId bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3
Retrieves the list item with UniqueId or GUID bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3 from the tasks lists
EXAMPLE 4
(Get-PnPListItem -List Tasks -Fields "Title","GUID").FieldValues
Retrieves all list items, but only includes the values of the Title and GUID fields in the list item object
EXAMPLE 5
Get-PnPListItem -List Tasks -Query "<View><Query><Where><Eq><FieldRef Name='GUID'/><Value Type='Guid'>bd6c5b3b-d960-4ee7-a02c-85dc6cd78cc3</Value></Eq></Where></Query></View>"
Retrieves all available fields of list items based on the CAML query specified
EXAMPLE 6
Get-PnPListItem -List Tasks -Query "<View><ViewFields><FieldRef Name='Title'/><FieldRef Name='Modified'/></ViewFields><Query><Where><Eq><FieldRef Name='Modified'/><Value Type='DateTime'><Today/></Value></Eq></Where></Query></View>"
Retrieves all list items modified today, retrieving the columns 'Title' and 'Modified'. When you use -Query, you can add a <ViewFields> clause to retrieve specific columns (since you cannot use -Fields)
EXAMPLE 7
Get-PnPListItem -List Tasks -PageSize 1000
Retrieves all list items from the Tasks list in pages of 1000 items
EXAMPLE 8
Get-PnPListItem -List Tasks -PageSize 1000 -ScriptBlock { Param($items) $items.Context.ExecuteQuery() } | ForEach-Object { $_.BreakRoleInheritance($true, $true) }
Retrieves all list items from the Tasks list in pages of 1000 items and breaks permission inheritance on each item
EXAMPLE 9
Get-PnPListItem -List Samples -FolderServerRelativeUrl "/sites/contosomarketing/Lists/Samples/Demo"
Retrieves all list items from the Demo folder in the Samples list located in the contosomarketing site collection
EXAMPLE 10
PS D:\Code> Get-PnPListItem -List "Shared Documents" | Select-Object id,@{label="Filename";expression={$_.FieldValues.FileLeafRef}}
Id Filename
-- --------
1 Contoso-Financial-Calendar-Q1_68340_97779.pptx
5 Does this work.docx
Retrieves all list items from the Shared Documents and shows each item's ID and Filename
EXAMPLE 11
Get-PnPListItem -List Tasks -Id 1 -IncludeContentType
Retrieves the list item with ID 1 from the Tasks list along with its content type information.
PARAMETERS
-Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Fields
The fields to retrieve.
If not specified, what comes back depends on the parameter set. By Id returns every field of the item. The All Items, By Unique Id and By Query parameter sets retrieve items through a CAML query which projects no fields, and SharePoint then returns at most 12 lookup columns and silently omits the rest, so on a list holding more than 12 of them those columns are absent from FieldValues rather than being reported as an error.
Naming the columns runs into the same threshold from the other side: SharePoint refuses a query that asks for more than 12 lookup columns, reporting The query cannot be completed because the number of lookup columns it contains exceeds the lookup column threshold. Together with -Id the fields are retrieved individually and the limit does not apply, but with All Items and By Unique Id the fields become the ViewFields of a query and it does, as it does for a <ViewFields> clause passed through -Query. A Lookup, Person or Group, Managed Metadata, Created By or Modified By column each count as one.
To read more than 12 lookup columns of a list, retrieve them in groups of 12 or fewer, or retrieve the items one at a time with -Id.
Type: String[]
Parameter Sets: All Items, By Id, By Unique Id
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FolderServerRelativeUrl
The server relative URL of a list folder from which results will be returned.
Type: String
Parameter Sets: All Items, By Query
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
The ID of the item to retrieve
Type: Int32
Parameter Sets: By Id
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-List
The list to query
Type: ListPipeBind
Parameter Sets: (All)
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-PageSize
The number of items to retrieve per page request.
Type: Int32
Parameter Sets: All Items, By Query
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Query
The CAML query to execute against the list
Type: String
Parameter Sets: By Query
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ScriptBlock
The script block to run after every page request.
Type: ScriptBlock
Parameter Sets: All Items, By Query
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UniqueId
The UniqueId or GUID of the item to retrieve
Type: Guid
Parameter Sets: By Unique Id
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IncludeContentType
If specified, it will retrieve the content type information of the list item(s).
Type: Switch Parameter
Parameter Sets: All
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False