GuidesAPI ReferenceGitHub RepositoryPartner IntegrationsWhat's New
API Reference
Product DocumentationSupportSandbox Account

List All SharePoint Site Collections

get
https://apis.druva.com/insync/sharepointmaster/v3/sites

Retrieve the list of SharePoint site collections.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
lastBackupStatus
array of strings

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.

lastBackupStatus
string

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

string
enum

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

Allowed:
string
enum

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.

integer
≤ 1000

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.

string

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'.

string
enum

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

Allowed:
string
enum

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

Allowed:
siteType
array of strings

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.

siteType
bulkExportStatus
array of strings

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

bulkExportStatus
lastBulkExportStatus
array of strings

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.

lastBulkExportStatus
integer

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).

errors
array of strings

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

errors
Responses

Updated 10 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago