Mastering SharePoint REST API: A Comprehensive Guide to Endpoints and Usage

Monday, April 13, 2020

Mastering SharePoint REST API: A Comprehensive Guide to Endpoints and Usage

Description: Unlock the full potential of SharePoint development with this master list of 31 essential REST API endpoints. A comprehensive guide for developers to perform CRUD operations, manage users, and handle files efficiently.

In the world of Microsoft 365 development, the SharePoint REST API is a fundamental skill. Whether you are working with Power Automate, custom SPFx components, or external applications, knowing the right endpoint can save you hours of troubleshooting. By using these endpoints, you can interact with SharePoint data using standard HTTP protocols.

I remember when I first shifted from Server-Side Object Model (SSOM) to REST. It felt liberating. No more remote desktop connections to the server—just clean, lightweight HTTP requests that could run from anywhere.

Below is a comprehensive list of 31 essential SharePoint REST API endpoints that every developer and administrator should have in their toolkit.

1. The Foundation: Base Endpoints

Every REST endpoint URL starts with a standard prefix. Understanding this structure is crucial for building your queries. If the base is wrong, nothing works.

1. The Base URL https://{site_url}/_api/
2. Access a specific Site Collection https://{site_url}/_api/site
3. Access a specific Site (Web) https://{site_url}/_api/web
4. Get the SharePoint Site Title https://{site_url}/_api/web/title

2. Working with SharePoint Lists

Lists are the core of SharePoint data storage. Use these endpoints to navigate list structures and metadata efficiently.

5. Get all lists from a site https://{site_url}/_api/web/lists
6. Get all items from a list https://{site_url}/_api/web/lists/getbytitle('list name')/items
7. Get a particular column ($select) .../items?$select=Title,Email
8. Get Lookup Field values ($expand) .../items?$select=Dept/Title&$expand=Dept
9. Get all columns (Fields) .../lists/getbytitle('list name')/Fields
10. Get a list by its GUID .../web/Lists(guid 'YOUR-GUID-HERE')
11. Get a specific list item by ID .../lists/getbytitle('list name')/items(2)

3. User and Group Management

Managing permissions and identifying users is a common requirement for governance and custom apps. These endpoints help you secure your data.

12. Get logged-in user information https://{site_url}/_api/web/currentUser
13. Get all SharePoint site users https://{site_url}/_api/web/siteusers
14. Get all SharePoint groups https://{site_url}/_api/web/sitegroups
15. Get a specific group by ID .../web/sitegroups/GetById(5)
16. Get all users from a specific group .../web/sitegroups(5)/users

4. Document Library and File Operations

Document management is where the REST API truly shines, offering granular control over files and folders that the UI sometimes hides.

17. Get all files from a folder .../GetFileByServerRelativeUrl('/sites/HR/Docs')/Files
18. Get metadata for a specific document .../GetFileByServerRelativeUrl('/path/file.docx')/listItemAllFields
19. Get the current version of a file .../items(23)?$select=FileLeafRef,OData__UIVersionString
20. Get the ETag of a document .../GetFileByServerRelativeUrl('/path/file.docx')/etag
21. Retrieve root folder of Shared Documents .../web/GetFolderByServerRelativeUrl('/Shared Documents')
22. Create a folder (POST) https://{siteurl}/_api/web/folders
23. Retrieve a specific file by name .../GetFolderByServerRelativeUrl('/Docs')/Files('report.pdf')
24. Download file content (Stream) .../GetFileByServerRelativeUrl('/path/file.docx')/$value
25. Create/Upload a file .../Files/add(url='new.txt',overwrite=true)
26. Check out a file .../GetFileByServerRelativeUrl('/path/file.docx')/CheckOut()
27. Check in a file .../CheckIn(comment='Done',checkintype=0)

5. List Item Attachments & Settings

28. Retrieve all attachments for an item .../lists/getbytitle('List')/items(1)/AttachmentFiles/
29. Retrieve a specific attachment .../items(1)/AttachmentFiles('image.png')/$value
30. Retrieve Tenant App Catalog URL https://api/SP_TenantSettings
31. Get Context Info (Digest) https://{site_url}/_api/contextinfo

Common Mistakes and Best Practices

Using these endpoints is easy, but mastering them requires attention to detail. Here are the keys to success:

  • Case Sensitivity: SharePoint internal names are case-sensitive. Always double-check your column's internal name.
  • Request Digest: When using POST, PUT, or DELETE methods, always include the X-RequestDigest header to prevent security errors.
  • Pagination: For lists with thousands of items, use $top to limit the results and improve performance.
  • Filtering: Always filter on the server side using $filter rather than downloading all data and filtering in your code.

FAQ Section

Q1: Can I test these endpoints directly in a browser?

Yes, for all GET requests, you can simply paste the URL into your browser while logged into your SharePoint site. You will see the raw XML or JSON data immediately.

Q2: What format does the REST API return?

By default, it often returns XML (Atom). To get JSON, you must set the HTTP Header: Accept: application/json;odata=verbose.

Q3: Is it possible to update an item using these endpoints?

Yes, you would use the item endpoint (e.g., items(id)) with a POST method and specific headers like X-HTTP-Method: MERGE and IF-MATCH.

Conclusion

The SharePoint REST API is a powerful tool that allows developers to go beyond the standard limitations of the UI. By mastering these 31 endpoints, you can build more efficient, robust, and customized solutions for your organization.

Did I miss any essential endpoints? Let me know in the comments below!

Tags