Getting Microsoft SharePoint Sites
You can get a resource representation of organization sites.
Request
GET https://<hostname>:4443/v5/Organizations/{organizationId}/Sites?includePersonalSites=<boolean> |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameter must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
organizationId | string | Specifies the identification number of the Office 365 organization. For more information on how to get this parameter, see Getting Organizations. |
The following optional parameter can be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
includePersonalSites | boolean | Defines whether the personal sites are included to the resource representation that will be returned to the client. Possible values:
The default value is false. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
In the response body, the server returns a resource representation of the /Organizations/{organizationId}/Sites resource.
Examples
Example 1
Request: GET https://abc.tech.local:4443/v5/Organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/Sites?includePersonalSites=true
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "id": "084282fd-ca6d-4f26-847a-3538f0ac84ea4d9b02b3-9ef9-4f4f-b22a-a63d17f12852", "url": "https://backup-my.sharepoint.com/personal/jdoe_backup_onmicrosoft_com", "name": "John Doe", "isCloud": true, "isPersonal": true, "title": "John Doe", "isAvailable": true, "_links": { "self": { "href": "https://abc.tech.local:4443/v5/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/sites/084282fd-ca6d-4f26-847a-3538f0ac84ea4d9b02b3-9ef9-4f4f-b22a-a63d17f12852" }, "children": { "href": "https://abc.tech.local:4443/v5/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/sites?parentId=084282fd-ca6d-4f26-847a-3538f0ac84ea4d9b02b3-9ef9-4f4f-b22a-a63d17f12852" }, "organization": { "href": "https://abc.tech.local:4443/v5/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e" } } },… |