SharePoint .NET Server, CSOM, JSOM, and REST API index

Note The name "apps for SharePoint" is changing to "SharePoint Add-ins". During the transition, the documentation and the UI of some SharePoint products and Visual Studio tools might still use the term "apps for SharePoint". For details, see New name for apps for Office and SharePoint.

SharePoint API index

Use the API index look up many of the most frequently used types and objects that are implemented in the .NET server object model and at least one client programming model: .NET client-side object model (CSOM), JavaScript object model (JSOM), and/or REST.

Table 1 lists the most frequently used, core APIs, which are in most cases based on types from the .NET server implementation. In some cases, types are native to SharePoint client programming, and there is no equivalent .NET server type. In other cases, some but not all possible client programming model implementations of a specific type exist.

Table 1. Frequently used Core APIs

API SP.Object/Enumeration (sp.js) REST Endpoint
AttachmentCollection SPAttachmentCollection SP.AttachmentCollection …/_api/web/lists('<list id>')/items(<item id>)/attachmentfiles
BasePermissions SPBasePermissions SP.BasePermissions object N/A
CalendarType SPCalendarType SP.CalendarType enumeration N/A
ChangeCollection SPChangeCollection SP.ChangeCollection object …/_api/web/getchanges(changequery)
ChangeSite SPChangeSite SP.ChangeSite enumeration N/A
ClientContext SP.ClientContext object …/_api/contextinfo
ContentType SPContentType SP.ContentType object …/_api/web/contenttypes('<content type id>')
ContentTypeCollection SPContentTypeCollection SP.ContentTypeCollection object …/_api/web/contenttypes
SPContext SP.RequestContext object N/A
EventReceiverDefinition SPEventReceiverDefinition SP.EventReceiverDefinition object …/_api/web/eventreceivers
EventReceiverDefinitionCollection SPEventReceiverDefinitionCollection SP.EventReceiverDefinitionCollection object …/_api/web/eventreceivers(eventreceiverid)
EventReceiverDefinitionCreationInformation SPEventReceiverDefinitionCreationInformation SP.EventReceiverDefinitionCreationInformation object N/A
EventReceiverType SPEventReceiverType SP.EventReceiverType enumeration N/A
Feature SPFeature SP.Feature object …/_api/web/features(featureid)
FeatureCollection SPFeatureCollection SP.FeatureCollection object …/_api/web/features
FeatureDefinitionScope SPFeatureDefinitionScope SP.FeatureDefinitionScope enumeration N/A
Field SPField SP.Field object …/_api/web/fields('')
FieldCalculated SPFieldCalculated SP.FieldCalculated object …/_api/web/fields('')
FieldChoice SPFieldChoice SP.FieldChoice object …/_api/web/fields('')
FieldCollection SPFieldCollection SP.FieldCollection object …/_api/web/fields
FieldComputed SPFieldComputed SP.FieldComputed object …/_api/web/fields('')
FieldCurrency SPFieldCurrency SP.FieldCurrency object …/_api/web/fields('')
FieldLink SPFieldLink SP.FieldLink object …/_api/web/contenttypes('<content type id>')/fieldlinks('<field link id>')
FieldLookupValue SPFieldLookupValue SP.FieldLookup object N/A
FieldMultiChoice SPFieldMultiChoice SP.FieldMultiChoice object …/_api/web/fields('')
FieldMultiLineText SPFieldMultiLineText SP.FieldMultiLineText object …/_api/web/fields('')
FieldNumber SPFieldNumber SP.FieldNumber object …/_api/web/fields('')
FieldText SPFieldText SP.FieldText object …/_api/web/fields('')
FieldUrl SPFieldUrl SP.FieldUrl object …/_api/web/fields('')
FieldUrlValue SPFieldUrlValue SP.FieldUrlValue object N/A
FieldUser SPFieldUser SP.FieldUser object …/_api/web/fields('')
File SPFile SP.File object …/_api/web/getfilebyserverrelativeurl('//')
FileCollection SPFileCollection SP.FieldCollection object …/_api/web/getfolderbyserverrelativeurl('/')/files
Folder SPFolder SP.Folder object …/_api/web/getfolderbyserverrelativeurl('/')
Form SPForm SP.Form object …/_api/web/lists(guid'<list id>')/forms('<form id>')
Group SPGroup SP.Group object …/_api/web/sitegroups()
GroupCollection SPGroupCollection SP.GroupCollection object …/_api/web/sitegroups
Language SPLanguage SP.Language object N/A
List SPList SP.List object …/_api/web/lists(guid'')
ListCollection SPListCollection SP.ListCollection object …/_api/web/lists
ListDataSource SPListDataSource SP.ListDataSource object N/A
ListItem SPListItem SP.ListItem object …/_api/web/lists(guid'')/items()
ListItemCollection SPListItemCollection SP.ListItemCollection object …/_api/web/lists(guid'')/items
ListTemplateType SPListTemplateType SP.ListTemplateType enumeration N/A
Navigation SPNavigation SP.Navigation object …/_api/web/navigation
NavigationNode SPNavigationNode SP.NavigationNode object N/A
Principal SPPrincipal SP.Principal object N/A
SPQuery N/A
RecycleBinItem SPRecycleBinItem SP.RecycleBinItem object …/_api/web/RecycleBin(recyclebinitemid)
RecycleBinItemCollection SPRecycleBinItemCollection SP.RecycleBinItemCollection object …/_api/web/RecycleBin
RegionalSettings SPRegionalSettings SP.RegionalSettings object …/_api/web/RegionalSettings
RoleAssignment SPRoleAssignment SP.RoleAssignment object …/_api/web/roleassignments()
RoleAssignmentCollection SPRoleAssignmentCollection SP.RoleAssignmentCollection object …/_api/web/roleassignments
RoleDefinition SPRoleDefinition SP.RoleDefinition object …/_api/web/roledefinitions()
RoleType SPRoleType SP.RoleType enumeration N/A
SecurableObject SPSecurableObject SP.SecurableObject object N/A
Site SPSite SP.Site object …/_api/site
TimeZone SPTimeZone SP.TimeZone object …/_api/web/RegionalSettings/TimeZones(timzoneid)
TimeZoneCollection SPTimeZoneCollection SP.TimeZoneCollection object …/_api/web/RegionalSettings/TimeZones
User SPUser SP.User object …/_api/web/siteusers(@v)?@v=''
UserCollection SPUserCollection SP.UserCollection object …/_api/web/sitegroups()/users
Utility SPUtility SP.Utilities.Utility object (sp.js) N/A
View SPView SP.View object (sp.js) …/_api/web/lists(guid'')/views('')
ViewCollection SPViewCollection SP.ViewCollection object …/_api/web/lists(guid'')/views
ViewFieldCollection SPViewFieldCollection SP.ViewFieldCollection object …/_api/web/lists(guid'')/views('')/fields
Web SPWeb SP.Web object …/_api/web
WebCollection SPWebCollection SP.WebCollection object …/_api/web/webs
WebInformation SPWebInfo SP.WebInformation object …/_api/web/webinfos('<web information id>')
WebTemplate SPWebTemplate SP.WebTemplate object …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)/getbyname(templatename)
WebTemplateCollection SPWebTemplateCollection SP.WebTemplateCollection object …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)

Note Before using a REST endpoint URI shown in the table, replace the abbreviation with the path to your SharePoint site, for example http://<site collection>/<site>/_api/web/lists.

Additional resources