REST API

The SharePoint Representational State Transfer (REST) API allows developers to perform CRUD (Create, Read, Update & Delete) operations from client-side code. These operations are similar to the SSOM (Server-Side Object Model), which was how developers created solutions in SharePoint 2007 & 2010 environments. The REST API was initially introduced in SharePoint 2013, but has been expanded in SharePoint 2016/2019/Online.

References

2013 Documentation

Online Documentation

Available End Points

The SharePoint REST API can be accessed by https://sp.site.url/_api/[endpoint]. The table below displays a list of the supported REST API endpoints in this library.

Name Library Reference Description
$REST.List List Gets list data from the current or web or site collection within the web application.
$REST.ListDataAsStream List Data Gets list data which have complex fields (lookups/mms)
$REST.Navigation Navigation Gets information from the navigation nodes.
$REST.PeopleManager People Manager  
$REST.PeoplePicker People Picker  
$REST.ProfileLoader Profile Loader  
$REST.RemoteWeb Remote Web  
$REST.Search Search  
$REST.Site Site Gets the site data from within the web application.
$REST.SiteExists Site Exists Determines if a site exists by url.
$REST.SiteUrl Site Url by Id Gets the site url by id.
$REST.SocialFeed Social Feed  
$REST.UserProfile User Profile  
$REST.Utility Utility  
$REST.Web Web Gets the web data from within the web application.