Edit

Share via

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

  • Article

Important

The SharePoint Add-In model in SharePoint Online has been deprecated as of November 27th 2023, checkout the full retirement announcement to learn more.

Deprecation means that the feature will not get any new investments, but it's still supported. SharePoint add-in model is retired fully on April 2nd, 2026 and is no longer available after that time. Primary replacement technology for the SharePoint add-in model is SharePoint Framework (SPFx) which continues to be supported also in future.

Use the API index to 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.

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

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.

SharePoint API index

APISP.Object/Enumeration (sp.js)REST Endpoint
AttachmentCollectionSPAttachmentCollectionSP.AttachmentCollection…/_api/web/lists('<list id>')/items(<item id>)/attachmentfiles
BasePermissionsSPBasePermissionsSP.BasePermissions object..._api/web/getusereffectivepermissions(@user)?@user='<user login name>'
CalendarTypeSPCalendarTypeSP.CalendarType enumerationN/A
ChangeCollectionSPChangeCollectionSP.ChangeCollection object…/_api/web/getchanges(changequery)
ChangeSiteSPChangeSiteSP.ChangeSite enumerationN/A
ClientContextSP.ClientContext object…/_api/contextinfo
ContentTypeSPContentTypeSP.ContentType object…/_api/web/contenttypes('<content type id>')
ContentTypeCollectionSPContentTypeCollectionSP.ContentTypeCollection object…/_api/web/contenttypes
SPContextSP.RequestContext objectN/A
EventReceiverDefinitionSPEventReceiverDefinitionSP.EventReceiverDefinition object…/_api/web/eventreceivers
EventReceiverDefinitionCollectionSPEventReceiverDefinitionCollectionSP.EventReceiverDefinitionCollection object…/_api/web/eventreceivers(eventreceiverid)
EventReceiverDefinitionCreationInformationSPEventReceiverDefinitionCreationInformationSP.EventReceiverDefinitionCreationInformation objectN/A
EventReceiverTypeSPEventReceiverTypeSP.EventReceiverType enumerationN/A
FeatureSPFeatureSP.Feature object…/_api/web/features(featureid)
FeatureCollectionSPFeatureCollectionSP.FeatureCollection object…/_api/web/features
FeatureDefinitionScopeSPFeatureDefinitionScopeSP.FeatureDefinitionScope enumerationN/A
FieldSPFieldSP.Field object…/_api/web/fields('<field id>')
FieldCalculatedSPFieldCalculatedSP.FieldCalculated object…/_api/web/fields('<field id>')
FieldChoiceSPFieldChoiceSP.FieldChoice object…/_api/web/fields('<field id>')
FieldCollectionSPFieldCollectionSP.FieldCollection object…/_api/web/fields
FieldComputedSPFieldComputedSP.FieldComputed object…/_api/web/fields('<field id>')
FieldCurrencySPFieldCurrencySP.FieldCurrency object…/_api/web/fields('<field id>')
FieldLinkSPFieldLinkSP.FieldLink object…/_api/web/contenttypes('<content type id>')/fieldlinks('<field link id>')
FieldLookupValueSPFieldLookupValueSP.FieldLookup object…/_api/web/fields('<field id>')
FieldMultiChoiceSPFieldMultiChoiceSP.FieldMultiChoice object…/_api/web/fields('<field id>')
FieldMultiLineTextSPFieldMultiLineTextSP.FieldMultiLineText object…/_api/web/fields('<field id>')
FieldNumberSPFieldNumberSP.FieldNumber object…/_api/web/fields('<field id>')
FieldTextSPFieldTextSP.FieldText object…/_api/web/fields('<field id>')
FieldUrlSPFieldUrlSP.FieldUrl object…/_api/web/fields('<field id>')
FieldUrlValueSPFieldUrlValueSP.FieldUrlValue object…/_api/web/fields('<field id>')
FieldUserSPFieldUserSP.FieldUser object…/_api/web/fields('<field id>')
FileSPFileSP.File object…/_api/web/getfilebyserverrelativeurl('<folder name>/<file name>')
FileCollectionSPFileCollectionSP.FieldCollection object…/_api/web/getfolderbyserverrelativeurl('/<folder name>')/files
FolderSPFolderSP.Folder object…/_api/web/getfolderbyserverrelativeurl('/<folder name>')
FormSPFormSP.Form object…/_api/web/lists(guid'<list id>')/forms('<form id>')
GroupSPGroupSP.Group object…/_api/web/sitegroups(<group id>)
GroupCollectionSPGroupCollectionSP.GroupCollection object…/_api/web/sitegroups
LanguageSPLanguageSP.Language objectN/A
ListSPListSP.List object…/_api/web/lists(guid'<list id>')
ListCollectionSPListCollectionSP.ListCollection object…/_api/web/lists
ListDataSourceSPListDataSourceSP.ListDataSource objectN/A
ListItemSPListItemSP.ListItem object…/_api/web/lists(guid'<list id>')/items(<item id>)
ListItemCollectionSPListItemCollectionSP.ListItemCollection object…/_api/web/lists(guid'<list id>')/items
ListTemplateTypeSPListTemplateTypeSP.ListTemplateType enumeration…/_api/web/lists(guid'<list id>')/BaseTemplate
NavigationSPNavigationSP.Navigation object…/_api/web/navigation
NavigationNodeSPNavigationNodeSP.NavigationNode objectN/A
PrincipalSPPrincipalSP.Principal objectN/A
SPQueryN/A
RecycleBinItemSPRecycleBinItemSP.RecycleBinItem object…/_api/web/RecycleBin(recyclebinitemid)
RecycleBinItemCollectionSPRecycleBinItemCollectionSP.RecycleBinItemCollection object…/_api/web/RecycleBin
RegionalSettingsSPRegionalSettingsSP.RegionalSettings object…/_api/web/RegionalSettings
RoleAssignmentSPRoleAssignmentSP.RoleAssignment object…/_api/web/roleassignments(<principal id>)
RoleAssignmentCollectionSPRoleAssignmentCollectionSP.RoleAssignmentCollection object…/_api/web/roleassignments
RoleDefinitionSPRoleDefinitionSP.RoleDefinition object…/_api/web/roledefinitions(<role definition id>)
RoleTypeSPRoleTypeSP.RoleType enumerationN/A
SecurableObjectSPSecurableObjectSP.SecurableObject objectN/A
SiteSPSiteSP.Site object…/_api/site
TimeZoneSPTimeZoneSP.TimeZone object…/_api/web/RegionalSettings/TimeZones(timzoneid)
TaxonomySPTaxonomySessionSP.Taxonomy.TaxonomySession objectNA
TimeZoneCollectionSPTimeZoneCollectionSP.TimeZoneCollection object…/_api/web/RegionalSettings/TimeZones
UserSPUserSP.User object…/_api/web/siteusers(@v)?@v='<login name>'
UserCollectionSPUserCollectionSP.UserCollection object…/_api/web/sitegroups(<group id>)/users
UtilitySPUtilitySP.Utilities.Utility object (sp.js)N/A
UsageInfoSPUsageInfoSP.UsageInfo.storage property (sp.js)…/_api/site/usage
ViewSPViewSP.View object (sp.js)…/_api/web/lists(guid'<list id>')/views('<view id>')
ViewCollectionSPViewCollectionSP.ViewCollection object…/_api/web/lists(guid'<list id>')/views
ViewFieldCollectionSPViewFieldCollectionSP.ViewFieldCollection object…/_api/web/lists(guid'<list id>')/views('<view id>')/fields
WebSPWebSP.Web object…/_api/web
WebCollectionSPWebCollectionSP.WebCollection object…/_api/web/webs
WebInformationSPWebInfoSP.WebInformation object…/_api/web/webinfos('<web information id>')
WebTemplateSPWebTemplateSP.WebTemplate object…/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)/getbyname(templatename)
WebTemplateCollectionSPWebTemplateCollectionSP.WebTemplateCollection object…/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)

See also