This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Microsoft SharePoint Sites by Organization and Site ID

In this article

This section explains how to get a resource representation of an organization site with the specified ID.

Request

GET https://<hostname>:4443/v4/Organizations/{organizationId}/Sites/{siteId}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be posted as URL.

Parameter	Type	Description
organizationId	string	An identification number of the organization.
siteId	string	An identification number of the SharePoint site.

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

Property	Type	Description
Id	string	Site ID.
URL	string	A path to the organization site.
Name	string	A site name.
Title	string	The title of the organization site.
IsBackedup	boolean	Specifies if this organization site is backed up.
Parent	site	Specifies _links for the parent object.
Children	site[]	Specifies _links for the children objects.
IsCloud	groupType	Specifies if this organization site is located in cloud.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Example

Request:

GET https://abc.tech.local:4443/v4/Organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/Sites/084282fd-ca6d-4f26-847a-3538f0ac84ea4d9b02b3-9ef9-4f4f-b22a-a63d17f12852

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

[

{

"id": "084282fd-ca6d-4f26-847a-3538f0ac84ea4d9b02b3-9ef9-4f4f-b22a-a63d17f12852",

"url": "https://backup-my.sharepoint.com/personal/jsnow_backup_onmicrosoft_com",

"name": "John Snow",

"isCloud": true,

"title": "John Snow",

"isBackedup": false,

"isAvailable": true,

"_links": {

"self": {

"href": "https://abc.tech.local:4443/v4/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/sites/084282fd-ca6d-4f26-847a-3538f0ac84ea4d9b02b3-9ef9-4f4f-b22a-a63d17f12852"

"children": {

"href": "https://abc.tech.local:4443/v4/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/sites?parentId=084282fd-ca6d-4f26-847a-3538f0ac84ea4d9b02b3-9ef9-4f4f-b22a-a63d17f12852"

"organization": {

"href": "https://abc.tech.local:4443/v4/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e"

}

…]