Description
Retrieves the list items in a SharePoint list.
Additional details regarding the "filters" property can be found here: https://social.technet.microsoft.com/wiki/contents/articles/35796.sharepoint-2013-using-rest-api-for-selecting-filtering-sorting-and-pagination-in-sharepoint-list.aspx#Filtering_items
It should be noted that only the "eq" filter is currently provided.
Parameters
| Name | Type | Description |
|---|---|---|
| listTitle | String | The title of the list that you want to retrieve the list items for. Exactly one of |
| listUrl | String | The relative server URL of the list that you want to retrieve the list items for. Exactly one of |
| authDetails | Object, optional | The authDetails set in the worker configuration to use. If not set the request will use the default authDetails |
| authDetails.identifier | String | The identifier of authDetails set in the worker configuration |
| authDetails.authType | String | The authType of authDetails set in the worker configuration |
| filters | Object, optional | A list of key/value pairs used to filter which list items are returned. The filter matches any key/value pairs that are exactly equal to the values of a list item. The key should related to the properties defined in SharePoint for the list |
| top | Integer, optional | The number of list items that should be returned. If not supplied, then it returns the first 100 list items |
| skipUntilId | Integer, optional | If specified, only list items after the Id specified will be returned. For example, if you specify |
| returnProperties | Array <strings>, optional | An array of strings containing the properties you want to retrieve. If this isn't specified, then all properties will be returned |
Example
{
"id": "123",
"jsonrpc": "2.0",
"method": "getListItems",
"params": {
"listTitle": "GossTest",
"filters": {
"Title": "GOSS Test"
},
"top": 2,
"skipUntilId": 2,
"returnProperties": ["Name", "Organisation"]
}
}
Last modified on June 27, 2023
Share this page
