Microsoft

Microsoft Graph: SharePoint sites and lists

Find SharePoint sites, read and write lists and list items, columns, content types, pages and site permissions. This listing is one area of Microsoft Graph,…

Productivity & workspace#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Find SharePoint sites, read and write lists and list items, columns, content types, pages and site permissions.

This listing is one area of Microsoft Graph, the single REST API for Microsoft 365, Outlook, OneDrive, Teams and Microsoft Entra ID. It holds 270 of the area's requests, the most direct ones first, generated from Microsoft's own OpenAPI description of Graph v1.0. The other areas (mail, calendar, files, Teams, users and more) are listed separately on the Microsoft page.

Get an access token

  1. Sign in to the Microsoft Entra admin center and open App registrations > New registration. For a quick test, the Graph Explorer signs you in and shows a token without registering anything.
  2. Under API permissions, add the Microsoft Graph permissions this area needs, for example: Sites.Read.All, Sites.ReadWrite.All, Sites.Selected. Delegated permissions act as the signed-in user; application permissions act as the app itself and need an administrator's consent.
  3. Under Certificates & secrets, create a client secret (keep it out of shared collections).
  4. Get a token from https://login.microsoftonline.com/ /oauth2/v2.0/token: the authorization-code flow for a user, or grant_type=client_credentials with scope=https://graph.microsoft.com/.default for an app. Send it as Authorization: Bearer .

Using these requests

  • Base URL: https://graph.microsoft.com/v1.0. /me/... paths act on the signed-in user; with an application token use /users/{id or userPrincipalName}/... instead.
  • Shape responses with OData query parameters: $select (fields), $filter, $orderby, $top, $expand and $search (some need the ConsistencyLevel: eventual header). Long lists are paged: follow @odata.nextLink.
  • Combine up to 20 requests in one call with POST /$batch.

Common errors

StatusCodeWhat to do
401InvalidAuthenticationTokenThe token is missing, expired or for another resource: get a new one for https://graph.microsoft.com.
403Authorization_RequestDenied / ErrorAccessDeniedAdd the permission listed in the request's docs and grant consent.
404ResourceNotFound / itemNotFoundCheck the id; ids from another user or tenant are not found.
429TooManyRequestsThrottled: wait the Retry-After seconds, then retry.

Docs: SharePoint sites and lists overview · Permissions reference · Throttling

Endpoints 270

Sites

  • GETList sites/sitesList all available sites in an organization. Specific filter criteria and query options are also supported and described below: In addition, you can use a…
  • POSTAdd site/sites/addFollow a user's site or multiple sites.
  • POSTRemove site/sites/removeUnfollow a user's site or multiple sites.
  • GETTrack changes to sites (delta)/sites/delta()Get newly created, updated, or deleted sites without having to perform a full read of the entire sites collection. A delta function call for sites is similar…
  • GETGet all sites (site)/sites/getAllSites()List sites across geographies in an organization. This API can also be used to enumerate all sites in a non-multi-geo tenant. For more information, see Best…
  • GETGet site/sites/:site-idRetrieve properties and relationships for a site resource. A site resource represents a team site in SharePoint.
  • PATCHUpdate site/sites/:site-id
  • GETGet site/sites/:site-id/getByPath(path=':path')
  • GETGet activities by interval (site)/sites/:site-id/getActivitiesByInterval()
  • GETGet site/sites/:site-id/getApplicableContentTypesForList(listId=':listId')Get site contentTypes that can be added to a list.
  • GETGet site/sites/:site-id/getActivitiesByInterval(startDateTime=':startDateTime',endDateTime=':endDateTime',interval=':interval')
  • GETGet drive/sites/:site-id/getByPath(path=':path')/driveThe default drive (document library) for this site.
  • GETList drives/sites/:site-id/getByPath(path=':path')/drivesThe collection of drives (document libraries) under this site.
  • GETGet activities by interval (site)/sites/:site-id/getByPath(path=':path')/getActivitiesByInterval()
  • GETGet site/sites/:site-id/getByPath(path=':path')/getApplicableContentTypesForList(listId=':listId')Get site contentTypes that can be added to a list.
  • GETGet site/sites/:site-id/getByPath(path=':path')/getActivitiesByInterval(startDateTime=':startDateTime',endDateTime=':endDateTime',interval=':interval')

Sites: items

  • GETList items/sites/:site-id/itemsUsed to address any item contained in this site. This collection can't be enumerated.
  • GETGet item/sites/:site-id/items/:baseItem-idUsed to address any item contained in this site. This collection can't be enumerated.
  • GETList items/sites/:site-id/getByPath(path=':path')/itemsUsed to address any item contained in this site. This collection can't be enumerated.

Sites: lists

  • GETList lists/sites/:site-id/listsGet the collection of lists for a site. Lists with the system facet are hidden by default. To list them, include system in your $select statement.
  • POSTCreate list/sites/:site-id/listsCreate a new list in a site.
  • GETGet list/sites/:site-id/lists/:list-idReturns the metadata for a list.
  • DELETEDelete list/sites/:site-id/lists/:list-id
  • PATCHUpdate list/sites/:site-id/lists/:list-id
  • GETList lists/sites/:site-id/getByPath(path=':path')/listsThe collection of lists under this site.
  • POSTCreate list/sites/:site-id/getByPath(path=':path')/lists
  • GETGet drive/sites/:site-id/lists/:list-id/driveAllows access to the list as a drive resource with driveItems. Only present on document libraries.
  • GETList items/sites/:site-id/lists/:list-id/itemsGet the collection of items in a list.
  • POSTCreate item/sites/:site-id/lists/:list-id/itemsCreate a new listItem in a list.
  • GETList columns/sites/:site-id/lists/:list-id/columnsGet the collection of columns represented as columnDefinition resources in a list.
  • POSTCreate column/sites/:site-id/lists/:list-id/columnsCreate a column for a list with a request that specifies a columnDefinition.
  • GETList operations/sites/:site-id/lists/:list-id/operationsThe collection of long-running operations on the list.
  • POSTCreate operation/sites/:site-id/lists/:list-id/operations
  • GETList permissions/sites/:site-id/lists/:list-id/permissionsGet a list of the permission objects associated with a list.
  • POSTCreate permission/sites/:site-id/lists/:list-id/permissionsCreate a new permission object on a list.
  • GETList content types/sites/:site-id/lists/:list-id/contentTypesGet the collection of contentType resources in a list.
  • POSTCreate content type/sites/:site-id/lists/:list-id/contentTypes
  • GETList subscriptions/sites/:site-id/lists/:list-id/subscriptionsThe set of subscriptions on the list.
  • POSTCreate subscription/sites/:site-id/lists/:list-id/subscriptions
  • GETTrack changes to items (delta)/sites/:site-id/lists/:list-id/items/delta()Get newly created, updated, or deleted list items without having to perform a full read of the entire items collection. Your app begins by calling delta…
  • GETGet item/sites/:site-id/lists/:list-id/items/:listItem-idReturns the metadata for an item in a list.
  • DELETEDelete item/sites/:site-id/lists/:list-id/items/:listItem-idRemoves an item from a list.
  • PATCHUpdate item/sites/:site-id/lists/:list-id/items/:listItem-id
  • POSTAdd copy (content type)/sites/:site-id/lists/:list-id/contentTypes/addCopyAdd a copy of a content type from a site to a list.
  • GETGet permission/sites/:site-id/lists/:list-id/permissions/:permission-idThe set of permissions for the item. Read-only. Nullable.
  • DELETEDelete permission/sites/:site-id/lists/:list-id/permissions/:permission-id
  • PATCHUpdate permission/sites/:site-id/lists/:list-id/permissions/:permission-id
  • GETGet item/sites/:site-id/lists/:list-id/items/delta(token=':token')
  • GETGet column/sites/:site-id/lists/:list-id/columns/:columnDefinition-idThe collection of field definitions for this list.
  • DELETEDelete column/sites/:site-id/lists/:list-id/columns/:columnDefinition-id
  • PATCHUpdate column/sites/:site-id/lists/:list-id/columns/:columnDefinition-id
  • GETGet content type/sites/:site-id/lists/:list-id/contentTypes/:contentType-idThe collection of content types present in this list.
  • DELETEDelete content type/sites/:site-id/lists/:list-id/contentTypes/:contentType-id
  • PATCHUpdate content type/sites/:site-id/lists/:list-id/contentTypes/:contentType-id
  • GETGet subscription/sites/:site-id/lists/:list-id/subscriptions/:subscription-idThe set of subscriptions on the list.
  • DELETEDelete subscription/sites/:site-id/lists/:list-id/subscriptions/:subscription-id
  • PATCHUpdate subscription/sites/:site-id/lists/:list-id/subscriptions/:subscription-id
  • GETGet vapid public key (subscription)/sites/:site-id/lists/:list-id/subscriptions/getVapidPublicKey()Get the public key information required to validate push notifications according to RFC 8292 specifications.
  • POSTAdd copy from content type hub (content type)/sites/:site-id/lists/:list-id/contentTypes/addCopyFromContentTypeHubAdd or sync a copy of a published content type from the content type hub to a target site or a list. This method is part of the content type publishing…
  • GETGet operation/sites/:site-id/lists/:list-id/operations/:richLongRunningOperation-idThe collection of long-running operations on the list.
  • DELETEDelete operation/sites/:site-id/lists/:list-id/operations/:richLongRunningOperation-id
  • PATCHUpdate operation/sites/:site-id/lists/:list-id/operations/:richLongRunningOperation-id
  • GETGet compatible hub content types (content type)/sites/:site-id/lists/:list-id/contentTypes/getCompatibleHubContentTypes()Get a list of compatible content types from the content type hub that can be added to a target site or a list. This method is part of the content type…
  • GETList fields/sites/:site-id/lists/:list-id/items/:listItem-id/fieldsThe values of the columns set on this list item.
  • DELETEDelete fields/sites/:site-id/lists/:list-id/items/:listItem-id/fields
  • PATCHUpdate fields/sites/:site-id/lists/:list-id/items/:listItem-id/fieldsUpdate the properties on a listItem.
  • GETList versions/sites/:site-id/lists/:list-id/items/:listItem-id/versionsSharePoint can be configured to retain the history for list items. Previous versions may be retained for a finite period of time depending on admin settings…
  • POSTCreate version/sites/:site-id/lists/:list-id/items/:listItem-id/versions
  • GETList analytics/sites/:site-id/lists/:list-id/items/:listItem-id/analyticsAnalytics about the view activities that took place on this item.
  • GETGet drive item/sites/:site-id/lists/:list-id/items/:listItem-id/driveItemFor document libraries, the driveItem relationship exposes the listItem as a driveItem
  • POSTCreate link (item)/sites/:site-id/lists/:list-id/items/:listItem-id/createLink
  • GETList permissions/sites/:site-id/lists/:list-id/items/:listItem-id/permissionsGet a list of the permission objects associated with a listItem.
  • POSTCreate permission/sites/:site-id/lists/:list-id/items/:listItem-id/permissions
  • POSTGrant permission/sites/:site-id/lists/:list-id/permissions/:permission-id/grantGrant users access to a link represented by a permission.
  • GETGet base/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/baseParent contentType from which this content type is derived.
  • GETList columns/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/columnsThe collection of column definitions for this content type.
  • POSTCreate column/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/columns
  • POSTCreate publish/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/publishPublishes a contentType present in the content type hub site.
  • GETList base types/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/baseTypesThe collection of content types that are ancestors of this content type.
  • POSTCreate unpublish/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/unpublishUnpublish a contentType from a content type hub site.
  • GETList document set versions/sites/:site-id/lists/:list-id/items/:listItem-id/documentSetVersionsGet a list of the versions of a document set item in a list.
  • POSTCreate document set version/sites/:site-id/lists/:list-id/items/:listItem-id/documentSetVersionsCreate a new version of a document set item in a list.
  • POSTRevoke grants (permission)/sites/:site-id/lists/:list-id/permissions/:permission-id/revokeGrantsRevoke access to a listItem or driveItem granted via a sharing link by removing the specified driveRecipient entries from the link. Recipients who already…
  • GETList column links/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/columnLinksThe collection of columns that are required by this content type.
  • POSTCreate column link/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/columnLinks
  • GETGet source column/sites/:site-id/lists/:list-id/columns/:columnDefinition-id/sourceColumnThe source column for the content type column.
  • GETIs published (content type)/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/isPublished()Check the publishing status of a contentType in a content type hub site.
  • POSTCreate reauthorize/sites/:site-id/lists/:list-id/subscriptions/:subscription-id/reauthorizeReauthorize a subscription when you receive a reauthorizationRequired challenge.
  • GETList column positions/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/columnPositionsColumn order information in a content type.
  • GETGet activities by interval (item)/sites/:site-id/lists/:list-id/items/:listItem-id/getActivitiesByInterval()
  • POSTCreate associate with hub site/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/associateWithHubSitesAssociate a published content type present in a content type hub with a list of hub sites.
  • POSTCopy to default content location (content type)/sites/:site-id/lists/:list-id/contentTypes/:contentType-id/copyToDefaultContentLocationCopy a file to a default content location in a content type. The file can then be added as a default file or template via a POST operation.
  • GETGet item/sites/:site-id/lists/:list-id/items/:listItem-id/getActivitiesByInterval(startDateTime=':startDateTime',endDateTime=':endDateTime',interval=':interval')

Sites: pages

  • GETList pages/sites/:site-id/pagesGet the collection of baseSitePage objects from the site pages list in a site. All pages in the site are returned (with pagination). Sort alphabetically by…
  • POSTCreate page/sites/:site-id/pagesCreate a new sitePage in the site pages list in a site.
  • GETGet site page/sites/:site-id/pages/graph.sitePageReturns the metadata for a sitePage in the site pages list in a site.
  • GETGet page/sites/:site-id/pages/:baseSitePage-idGet the metadata for a baseSitePage in the site pages list in a site.
  • DELETEDelete page/sites/:site-id/pages/:baseSitePage-idDelete a baseSitePage from the site pages list in a site.
  • PATCHUpdate page/sites/:site-id/pages/:baseSitePage-id
  • GETList pages/sites/:site-id/getByPath(path=':path')/pagesThe collection of pages in the baseSitePages list in this site.
  • POSTCreate page/sites/:site-id/getByPath(path=':path')/pages
  • GETGet site page/sites/:site-id/pages/:baseSitePage-id/graph.sitePageReturns the metadata for a sitePage in the site pages list in a site.
  • GETList web parts/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/webPartsCollection of webparts on the SharePoint page.
  • POSTCreate web part/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/webParts
  • GETGet canvas layout/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/canvasLayoutIndicates the layout of the content in a given SharePoint page, including horizontal sections and vertical sections.
  • DELETEDelete canvas layout/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/canvasLayout
  • PATCHUpdate canvas layout/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/canvasLayout
  • GETGet web part/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/webParts/:webPart-idCollection of webparts on the SharePoint page.
  • DELETEDelete web part/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/webParts/:webPart-idDelete a webPart object.
  • PATCHUpdate web part/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/webParts/:webPart-id
  • GETGet vertical section/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/canvasLayout/verticalSectionVertical section on the SharePoint page.
  • DELETEDelete vertical section/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/canvasLayout/verticalSection
  • PATCHUpdate vertical section/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/canvasLayout/verticalSection
  • GETList horizontal sections/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/canvasLayout/horizontalSectionsCollection of horizontal sections on the SharePoint page.
  • POSTCreate horizontal section/sites/:site-id/pages/:baseSitePage-id/graph.sitePage/canvasLayout/horizontalSections

Sites: sites

  • GETList sites/sites/:site-id/sitesGet a collection of subsites defined for a site.
  • GETGet site/sites/:site-id/sites/:site-id1The collection of the sub-sites under this site.
  • GETList sites/sites/:site-id/getByPath(path=':path')/sitesThe collection of the sub-sites under this site.

Sites: columns

  • GETList columns/sites/:site-id/columnsGet the collection of columns represented as columnDefinition resources in a site.
  • POSTCreate column/sites/:site-id/columnsCreate a column for a site with a request that specifies a columnDefinition.
  • GETGet column/sites/:site-id/columns/:columnDefinition-idThe collection of column definitions reusable across lists under this site.
  • DELETEDelete column/sites/:site-id/columns/:columnDefinition-id
  • PATCHUpdate column/sites/:site-id/columns/:columnDefinition-id
  • GETList columns/sites/:site-id/getByPath(path=':path')/columnsThe collection of column definitions reusable across lists under this site.
  • POSTCreate column/sites/:site-id/getByPath(path=':path')/columns
  • GETGet source column/sites/:site-id/columns/:columnDefinition-id/sourceColumnThe source column for the content type column.

Sites: analytics

  • GETList analytics/sites/:site-id/analyticsAnalytics about the view activities that took place on this site.
  • DELETEDelete analytics/sites/:site-id/analytics
  • PATCHUpdate analytics/sites/:site-id/analytics
  • GETGet all time/sites/:site-id/analytics/allTime
  • GETList last seven days/sites/:site-id/analytics/lastSevenDays
  • GETList item activity stats/sites/:site-id/analytics/itemActivityStats
  • POSTCreate item activity stat/sites/:site-id/analytics/itemActivityStats
  • GETList analytics/sites/:site-id/getByPath(path=':path')/analyticsAnalytics about the view activities that took place on this site.
  • DELETEDelete analytics/sites/:site-id/getByPath(path=':path')/analytics
  • PATCHUpdate analytics/sites/:site-id/getByPath(path=':path')/analytics
  • GETGet item activity stat/sites/:site-id/analytics/itemActivityStats/:itemActivityStat-id
  • DELETEDelete item activity stat/sites/:site-id/analytics/itemActivityStats/:itemActivityStat-id
  • PATCHUpdate item activity stat/sites/:site-id/analytics/itemActivityStats/:itemActivityStat-id
  • GETList activities/sites/:site-id/analytics/itemActivityStats/:itemActivityStat-id/activitiesExposes the itemActivities represented in this itemActivityStat resource.
  • POSTCreate activity/sites/:site-id/analytics/itemActivityStats/:itemActivityStat-id/activities
  • GETGet activity/sites/:site-id/analytics/itemActivityStats/:itemActivityStat-id/activities/:itemActivity-idExposes the itemActivities represented in this itemActivityStat resource.
  • DELETEDelete activity/sites/:site-id/analytics/itemActivityStats/:itemActivityStat-id/activities/:itemActivity-id
  • PATCHUpdate activity/sites/:site-id/analytics/itemActivityStats/:itemActivityStat-id/activities/:itemActivity-id

Sites: term store

  • GETGet term store/sites/:site-id/termStoreRead the properties and relationships of a store object.
  • DELETEDelete term store/sites/:site-id/termStore
  • PATCHUpdate term store/sites/:site-id/termStoreUpdate the properties of a store object.
  • GETList sets/sites/:site-id/termStore/setsRead the properties and relationships of a set object.
  • POSTCreate set/sites/:site-id/termStore/setsCreate a new set object.
  • GETList groups/sites/:site-id/termStore/groupsGet a list of group objects in a term store.
  • POSTCreate group/sites/:site-id/termStore/groupsCreate a new group object in a term store.
  • GETGet term store/sites/:site-id/getByPath(path=':path')/termStoreThe default termStore under this site.
  • DELETEDelete term store/sites/:site-id/getByPath(path=':path')/termStore
  • PATCHUpdate term store/sites/:site-id/getByPath(path=':path')/termStore
  • GETGet set/sites/:site-id/termStore/sets/:set-idRead the properties and relationships of a set object.
  • DELETEDelete set/sites/:site-id/termStore/sets/:set-idDelete a set object.
  • PATCHUpdate set/sites/:site-id/termStore/sets/:set-idUpdate the properties of a set object.
  • GETGet group/sites/:site-id/termStore/groups/:group-idRead the properties and relationships of a term store group object.
  • DELETEDelete group/sites/:site-id/termStore/groups/:group-idDelete a group object in a term [store].
  • PATCHUpdate group/sites/:site-id/termStore/groups/:group-id
  • GETList terms/sites/:site-id/termStore/sets/:set-id/termsAll the terms under the set.
  • POSTCreate term/sites/:site-id/termStore/sets/:set-id/terms
  • GETList sets/sites/:site-id/termStore/groups/:group-id/setsGet a list of the set objects and their properties.
  • POSTCreate set/sites/:site-id/termStore/groups/:group-id/sets
  • GETGet children/sites/:site-id/termStore/sets/:set-id/childrenGet the first level children of a [set] or [term] resource using the children navigation property.
  • POSTCreate children/sites/:site-id/termStore/sets/:set-id/childrenCreate a new term object.
  • GETList relations/sites/:site-id/termStore/sets/:set-id/relationsGet the different relation of a [term] or [set] from the relations navigation property.
  • POSTCreate relation/sites/:site-id/termStore/sets/:set-id/relations
  • GETGet parent group/sites/:site-id/termStore/sets/:set-id/parentGroupThe parent [group] that contains the set.
  • DELETEDelete parent group/sites/:site-id/termStore/sets/:set-id/parentGroup
  • PATCHUpdate parent group/sites/:site-id/termStore/sets/:set-id/parentGroup
  • GETGet term/sites/:site-id/termStore/sets/:set-id/terms/:term-idAll the terms under the set.
  • DELETEDelete term/sites/:site-id/termStore/sets/:set-id/terms/:term-idDelete a term object.
  • PATCHUpdate term/sites/:site-id/termStore/sets/:set-id/terms/:term-idUpdate the properties of a term object.
  • GETList sets/sites/:site-id/termStore/sets/:set-id/parentGroup/setsAll sets under the group in a term [store].
  • POSTCreate set/sites/:site-id/termStore/sets/:set-id/parentGroup/sets
  • GETGet set/sites/:site-id/termStore/groups/:group-id/sets/:set-idAll sets under the group in a term [store].
  • DELETEDelete set/sites/:site-id/termStore/groups/:group-id/sets/:set-id
  • PATCHUpdate set/sites/:site-id/termStore/groups/:group-id/sets/:set-id
  • GETGet children/sites/:site-id/termStore/sets/:set-id/children/:term-idChildren terms of set in term [store].
  • DELETEDelete children/sites/:site-id/termStore/sets/:set-id/children/:term-id
  • PATCHUpdate children/sites/:site-id/termStore/sets/:set-id/children/:term-id
  • GETGet relation/sites/:site-id/termStore/sets/:set-id/relations/:relation-idIndicates which terms have been pinned or reused directly under the set.
  • DELETEDelete relation/sites/:site-id/termStore/sets/:set-id/relations/:relation-id
  • PATCHUpdate relation/sites/:site-id/termStore/sets/:set-id/relations/:relation-id

Sites: operations

  • GETList operations/sites/:site-id/operationsGet a list of rich long-running operations associated with a site.
  • POSTCreate operation/sites/:site-id/operations
  • GETList operations/sites/:site-id/getByPath(path=':path')/operationsThe collection of long-running operations on the site.
  • POSTCreate operation/sites/:site-id/getByPath(path=':path')/operations
  • GETGet operation/sites/:site-id/operations/:richLongRunningOperation-idGet the status of a rich long-running operation on a site or a list.
  • DELETEDelete operation/sites/:site-id/operations/:richLongRunningOperation-id
  • PATCHUpdate operation/sites/:site-id/operations/:richLongRunningOperation-id

Sites: term stores

  • GETList term stores/sites/:site-id/termStoresThe collection of termStores under this site.
  • POSTCreate term store/sites/:site-id/termStores
  • GETGet term store/sites/:site-id/termStores/:store-idThe collection of termStores under this site.
  • DELETEDelete term store/sites/:site-id/termStores/:store-id
  • PATCHUpdate term store/sites/:site-id/termStores/:store-id
  • GETList term stores/sites/:site-id/getByPath(path=':path')/termStoresThe collection of termStores under this site.
  • POSTCreate term store/sites/:site-id/getByPath(path=':path')/termStores
  • GETList sets/sites/:site-id/termStores/:store-id/setsCollection of all sets available in the term store. This relationship can only be used to load a specific term set.
  • POSTCreate set/sites/:site-id/termStores/:store-id/sets
  • GETList groups/sites/:site-id/termStores/:store-id/groupsCollection of all groups available in the term store.
  • POSTCreate group/sites/:site-id/termStores/:store-id/groups
  • GETGet set/sites/:site-id/termStores/:store-id/sets/:set-idCollection of all sets available in the term store. This relationship can only be used to load a specific term set.
  • DELETEDelete set/sites/:site-id/termStores/:store-id/sets/:set-id
  • PATCHUpdate set/sites/:site-id/termStores/:store-id/sets/:set-id
  • GETGet group/sites/:site-id/termStores/:store-id/groups/:group-idCollection of all groups available in the term store.
  • DELETEDelete group/sites/:site-id/termStores/:store-id/groups/:group-id
  • PATCHUpdate group/sites/:site-id/termStores/:store-id/groups/:group-id
  • GETList terms/sites/:site-id/termStores/:store-id/sets/:set-id/termsAll the terms under the set.
  • POSTCreate term/sites/:site-id/termStores/:store-id/sets/:set-id/terms
  • GETList sets/sites/:site-id/termStores/:store-id/groups/:group-id/setsAll sets under the group in a term [store].
  • POSTCreate set/sites/:site-id/termStores/:store-id/groups/:group-id/sets
  • GETGet children/sites/:site-id/termStores/:store-id/sets/:set-id/childrenChildren terms of set in term [store].
  • POSTCreate children/sites/:site-id/termStores/:store-id/sets/:set-id/children
  • GETList relations/sites/:site-id/termStores/:store-id/sets/:set-id/relationsIndicates which terms have been pinned or reused directly under the set.
  • POSTCreate relation/sites/:site-id/termStores/:store-id/sets/:set-id/relations
  • GETGet parent group/sites/:site-id/termStores/:store-id/sets/:set-id/parentGroupThe parent [group] that contains the set.
  • DELETEDelete parent group/sites/:site-id/termStores/:store-id/sets/:set-id/parentGroup
  • PATCHUpdate parent group/sites/:site-id/termStores/:store-id/sets/:set-id/parentGroup

Sites: permissions

  • GETList permissions/sites/:site-id/permissionsGet the permission resources from the permissions navigation property on a site.
  • POSTCreate permission/sites/:site-id/permissionsCreate a new permission object on a site.
  • GETGet permission/sites/:site-id/permissions/:permission-idRetrieve the properties and relationships of a permission object on a site.
  • DELETEDelete permission/sites/:site-id/permissions/:permission-idDelete a permission object on a site.
  • PATCHUpdate permission/sites/:site-id/permissions/:permission-idUpdate an application permission object on a site.
  • GETList permissions/sites/:site-id/getByPath(path=':path')/permissionsThe permissions associated with the site. Nullable.
  • POSTCreate permission/sites/:site-id/getByPath(path=':path')/permissions
  • POSTGrant permission/sites/:site-id/permissions/:permission-id/grantGrant users access to a link represented by a permission.
  • POSTRevoke grants (permission)/sites/:site-id/permissions/:permission-id/revokeGrantsRevoke access to a listItem or driveItem granted via a sharing link by removing the specified driveRecipient entries from the link. Recipients who already…

Sites: content types

  • GETList content types/sites/:site-id/contentTypesGet the collection of contentType resources in a site.
  • POSTCreate content type/sites/:site-id/contentTypesCreate a new contentType in a site.
  • POSTAdd copy (content type)/sites/:site-id/contentTypes/addCopyAdd a copy of a content type from a site to a list.
  • GETGet content type/sites/:site-id/contentTypes/:contentType-idRetrieve the metadata for a content type in a site or a list.
  • DELETEDelete content type/sites/:site-id/contentTypes/:contentType-idRemove a content type from a list or a site.
  • PATCHUpdate content type/sites/:site-id/contentTypes/:contentType-idUpdate a content type.
  • GETList content types/sites/:site-id/getByPath(path=':path')/contentTypesThe collection of content types defined for this site.
  • POSTCreate content type/sites/:site-id/getByPath(path=':path')/contentTypes
  • POSTAdd copy from content type hub (content type)/sites/:site-id/contentTypes/addCopyFromContentTypeHubAdd or sync a copy of a published content type from the content type hub to a target site or a list. This method is part of the content type publishing…
  • GETGet compatible hub content types (content type)/sites/:site-id/contentTypes/getCompatibleHubContentTypes()Get a list of compatible content types from the content type hub that can be added to a target site or a list. This method is part of the content type…
  • GETGet base/sites/:site-id/contentTypes/:contentType-id/baseParent contentType from which this content type is derived.
  • GETList columns/sites/:site-id/contentTypes/:contentType-id/columnsGet the collection of columns represented as columnDefinition resources in a content type.
  • POSTCreate column/sites/:site-id/contentTypes/:contentType-id/columnsAdd a column to a content type in a site, or a list with a request that specifies a columnDefinition.
  • POSTCreate publish/sites/:site-id/contentTypes/:contentType-id/publishPublishes a contentType present in the content type hub site.
  • GETList base types/sites/:site-id/contentTypes/:contentType-id/baseTypesThe collection of content types that are ancestors of this content type.
  • POSTCreate unpublish/sites/:site-id/contentTypes/:contentType-id/unpublishUnpublish a contentType from a content type hub site.
  • GETList column links/sites/:site-id/contentTypes/:contentType-id/columnLinksThe collection of columns that are required by this content type.
  • POSTCreate column link/sites/:site-id/contentTypes/:contentType-id/columnLinks
  • GETIs published (content type)/sites/:site-id/contentTypes/:contentType-id/isPublished()Check the publishing status of a contentType in a content type hub site.
  • GETList column positions/sites/:site-id/contentTypes/:contentType-id/columnPositionsColumn order information in a content type.
  • POSTCreate associate with hub site/sites/:site-id/contentTypes/:contentType-id/associateWithHubSitesAssociate a published content type present in a content type hub with a list of hub sites.
  • POSTCopy to default content location (content type)/sites/:site-id/contentTypes/:contentType-id/copyToDefaultContentLocationCopy a file to a default content location in a content type. The file can then be added as a default file or template via a POST operation.
  • GETGet base type/sites/:site-id/contentTypes/:contentType-id/baseTypes/:contentType-id1The collection of content types that are ancestors of this content type.
  • GETGet column link/sites/:site-id/contentTypes/:contentType-id/columnLinks/:columnLink-idThe collection of columns that are required by this content type.
  • DELETEDelete column link/sites/:site-id/contentTypes/:contentType-id/columnLinks/:columnLink-id
  • PATCHUpdate column link/sites/:site-id/contentTypes/:contentType-id/columnLinks/:columnLink-id
  • GETGet column/sites/:site-id/contentTypes/:contentType-id/columns/:columnDefinition-idRetrieve the metadata for a site, a list, or a contentType column.
  • DELETEDelete column/sites/:site-id/contentTypes/:contentType-id/columns/:columnDefinition-idRemove a column from a site, a list, or a content type.
  • PATCHUpdate column/sites/:site-id/contentTypes/:contentType-id/columns/:columnDefinition-idUpdate a site, a list, or a content type column.
  • GETGet column position/sites/:site-id/contentTypes/:contentType-id/columnPositions/:columnDefinition-idColumn order information in a content type.
  • GETGet source column/sites/:site-id/contentTypes/:contentType-id/columns/:columnDefinition-id/sourceColumnThe source column for the content type column.

Sites: external columns

  • GETList external columns/sites/:site-id/externalColumns
  • GETGet external column/sites/:site-id/externalColumns/:columnDefinition-id
  • GETList external columns/sites/:site-id/getByPath(path=':path')/externalColumns

Sites: onenote

  • GETGet onenote/sites/:site-id/getByPath(path=':path')/onenoteCalls the OneNote service for notebook related operations.
  • DELETEDelete onenote/sites/:site-id/getByPath(path=':path')/onenote
  • PATCHUpdate onenote/sites/:site-id/getByPath(path=':path')/onenote

Followed sites

  • GETList followed sites/me/followedSitesList the sites that have been followed by the signed in user.
  • POSTAdd followed site/me/followedSites/addFollow a user's site or multiple sites.
  • POSTRemove followed site/me/followedSites/removeUnfollow a user's site or multiple sites.
  • GETGet followed site/me/followedSites/:site-id

API details

Base URL
https://graph.microsoft.com/v1.0
Authentication
OAuth 2.0 (authorization code, client credentials flows)
Operations
270 operations on 153 pathsGET 131POST 66PATCH 37DELETE 36
Main resources
Sites: lists 74Sites: term store 41Sites: content types 31Sites: term stores 28Sites: pages 22Sites: analytics 18Sites 16Sites: permissions 9Sites: columns 8Sites: operations 7
Description format
OpenAPI 3.0.4, API version v1.0

How to test the Microsoft Graph: SharePoint sites and lists in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Microsoft Graph: SharePoint sites and lists collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code, client credentials flows). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List sites” (GET /sites), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Microsoft Graph: SharePoint sites and lists?

Find SharePoint sites, read and write lists and list items, columns, content types, pages and site permissions. This listing is one area of Microsoft Graph,… It is listed under Productivity & workspace and has 270 endpoints.

Who publishes the Microsoft Graph: SharePoint sites and lists?

It is listed from Microsoft's public API description (an OpenAPI document), not published by Microsoft on Swastik Codes. Anyone who controls microsoft.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Microsoft Graph: SharePoint sites and lists?

Requests go to https://graph.microsoft.com/v1.0. Endpoint paths are added to this base URL.

How do I authenticate with the Microsoft Graph: SharePoint sites and lists?

With OAuth 2.0 (authorization code, client credentials flows).

How many endpoints does the Microsoft Graph: SharePoint sites and lists have?

270 operations on 153 paths (131 GET, 66 POST, 37 PATCH, 36 DELETE). The largest groups are Sites: lists, Sites: term store, Sites: content types, Sites: term stores.

Is forking the Microsoft Graph: SharePoint sites and lists free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.