Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Restore SharePoint Online data

List All SharePoint Site Collections

Retrieve the list of SharePoint site collections.

get/insync/sharepointmaster/v3/sites

Query parameters

lastBackupStatusstring[]

Specify the backup status of the SharePoint site for filtering. Set this value to one of the following: Backup Failed, Backed Up With Errors, Backed Up Successfully, Successful with errors, Never Backed Up, or Backup Cancelled. Leave empty to return all sites.

searchTermstring

Specify the title or URL of the SharePoint site for filtering.

sortOrder'asc' | 'desc'

Specify the sorting order for the results. Use asc for ascending or desc for descending.

sortByColumn'siteCollectionId' | 'title' | 'siteStatus' | 'lastBackupStatus' | 'statusDetails' | 'siteType' | 'bulkExportStatus' | 'lastBulkExportStatus' | 'lastCompletedBulkExport' | 'lastSync' | 'backupData' | 'siteCollectionUrl' | 'configurationStatus' | 'appState'

Specify the column name to sort the results. Example: Choose lastSync to arrange the results based on the last synchronization time of the SharePoint site.

pageSizeinteger

Specify the number of records to retrieve per request. For example, if you want to retrieve 100 records in each request, set the pageSize as 100.

nextPageTokenstring

Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.

appState'Enabled' | 'Disabled'

Specify the status of the SharePoint site for filtering. Set this value to one of the following: Enabled or Disabled.

configurationStatus'Configured' | 'Not Configured'

Specify the configuration status of the SharePoint site for filtering. Set this value to one of the following: Configured or Not Configured

siteTypestring[]

Specify the type of SharePoint site for filtering. Set this value to one of the following: MS Teams Site, M365 Groups Site, MS Teams Private Channel Site or Other Site.

bulkExportStatusstring[]

Specify the Bulk Export Status of the SharePoint site for filtering. Set this value to one of the following: Enabled or Disabled.

lastBulkExportStatusstring[]

Specify the Last Bulk Export Status of the SharePoint site for filtering. Set this value to one of the following: Completed Successfully, Failed, Completed With Errors or Never Exported.

pageNumberinteger

Specify the pageNumber parameter to indicate the page of results to retrieve in paginated API requests.

For example, when initially calling the API with a pageSize of 100, the first request returns records 1 to 100. Subsequent pages can be fetched using either the nextPageToken or pageNumber parameter.

This parameter allows you to directly retrieve records from a specific page (e.g., records 401 to 500) by providing the desired page number (e.g., 5).

errorsstring[]

Specify a comma-separated list of specific error codes to filter the results. Example: use codes like SPO-01, SPO-02, and so on.

[
  "MS-01",
  "SPO-22"
]

Response

success

statusinteger

SharePoint site status eg. 0-Disabled, 1-Enabled

nextPageTokenstring

Token to be used in next request to fetch next page data.

totalResultinteger

Total no of SharePoint sites available with provided filter criteria.

pageSizeinteger

Current page size i.e no of records to fetched per page

Example response

{
  "nextPageToken": "Mg==",
  "totalResult": 3500,
  "pageSize": 1000,
  "siteCollections": [
    {
      "lastSync": 1712909603,
      "siteType": "M365 Groups Site",
      "siteCollectionId": 123,
      "siteCollectionUrl": "https://druvaglobalind.sharepoint.com/sites/SC_V",
      "backupData": 19745050,
      "backupDataStr": "18.83 MB",
      "guid": "a0de3f5a-e0b8-41ce-9bc2-446932c5420f",
      "useDefaultSettings": true,
      "errors": [
        "MS-01",
        "SPO-22"
      ],
      "titleUrl": "https://insync-prasadp.drtst.in/admin/app/#/cloudapps/office365/sharepoint/1/summary",
      "lastBackupJob": 1712909603,
      "title": "SC_V",
      "bulkExportStatus": "Disabled",
      "filescurrent": 471,
      "lastSyncTime": 1712909603,
      "enabled": 1,
      "lastBackupStatus": "Backed Up Successfully",
      "configured": true,
      "currentBackupData": 19745050,
      "geoLocation": "IND",
      "workload": "SharePoint",
      "createdOn": 1710165704,
      "useDefaultExportSettings": true,
      "siteStatusStr": "Not Configured",
      "customerId": 2,
      "internalTitle": "SC_V_Main"
    }
  ]
}