Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
The SharePoint Add-In model in SharePoint Online has been deprecated on November 27, 2023 and fully retired on April 2, 2026. For more information, see SharePoint Add-In retirement in Microsoft 365.
The recommended replacement technology for the SharePoint add-in model is SharePoint Framework (SPFx).
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://.
SharePoint API index
| API | SP.Object/Enumeration (sp.js) | REST Endpoint |
|---|---|---|
| AttachmentCollection SPAttachmentCollection | SP.AttachmentCollection | …/_api/web/lists(' |
| BasePermissions SPBasePermissions | SP.BasePermissions object | ..._api/web/getusereffectivepermissions(@user)?@user=' |
| 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(' |
| 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(' |
| FieldLookupValue SPFieldLookupValue | SP.FieldLookup object | …/_api/web/fields(' |
| 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 | …/_api/web/fields(' |
| FieldUser SPFieldUser | SP.FieldUser object | …/_api/web/fields(' |
| File SPFile | SP.File object | …/_api/web/getfilebyserverrelativeurl(' |
| FileCollection SPFileCollection | SP.FieldCollection object | …/_api/web/getfolderbyserverrelativeurl('/ |
| Folder SPFolder | SP.Folder object | …/_api/web/getfolderbyserverrelativeurl('/ |
| Form SPForm | SP.Form object | …/_api/web/lists(guid' |
| 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'
|
| ListItemCollection SPListItemCollection | SP.ListItemCollection object | …/_api/web/lists(guid'
|
| ListTemplateType SPListTemplateType | SP.ListTemplateType enumeration | …/_api/web/lists(guid'
|
| 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) |
| Taxonomy SPTaxonomySession | SP.Taxonomy.TaxonomySession object | NA |
| 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( |
| Utility SPUtility | SP.Utilities.Utility object (sp.js) | N/A |
| UsageInfo SPUsageInfo | SP.UsageInfo.storage property (sp.js) | …/_api/site/usage |
| View SPView | SP.View object (sp.js) | …/_api/web/lists(guid'
|
| ViewCollection SPViewCollection | SP.ViewCollection object | …/_api/web/lists(guid'
|
| ViewFieldCollection SPViewFieldCollection | SP.ViewFieldCollection object | …/_api/web/lists(guid'
|
| Web SPWeb | SP.Web object | …/_api/web |
| WebCollection SPWebCollection | SP.WebCollection object | …/_api/web/webs |
| WebInformation SPWebInfo | SP.WebInformation object | …/_api/web/webinfos(' |
| WebTemplate SPWebTemplate | SP.WebTemplate object | …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage)/getbyname(templatename) |
| WebTemplateCollection SPWebTemplateCollection | SP.WebTemplateCollection object | …/_api/web/GetAvailableWebTemplates(languageid,includecrosslanguage) |