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

(GET) /RestoreSessions/{{restoreSessionId}/Organization/Mailboxes/{maiboxId}/Folders

In this article

Returns a resource representation of Exchange organization's mailbox folders for exploring and restoring mailbox folder data.

Request

To get a resource representation of the organization's mailbox folders, send the GET HTTPS request to the URL of the /RestoreSessions/{{restoreSessionId}/Organization/Mailboxes/{maiboxId}/Folders resource:

HTTPS Request

GET https://<Backup-Office365>:4443/v3/RestoreSessions/{{restoreSessionId}/Organization/Mailboxes/{maiboxId}/Folders

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns 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 request body message: application/json; charset=utf-8

Response Body

In the response body, the server returns a representation of the /RestoreSessions/{{restoreSessionId}/Organization/Mailboxes/{maiboxId}/Folders resource.

Example 1

The following request returns an entity representation of the organization's mailbox folders and subfolders. The server will return a page with first 30 elements of the /RestoreSessions/{{restoreSessionId}/Organization/Mailboxes/{maiboxId}/Folders resource collection.

Request:

GET https://support.east.local:4443/v3/RestoreSessions/0800471b-d0e2-422b-9d7c-35d15661c3fb/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"results": [

{

"name": "Birthdays",

"type": "None",

"description": "",

"_links": {

"self": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUYAAA=="

"parent": {

"children": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUYAAA=="

"items": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUYAAA=="

"mailbox": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoretoOriginallocation": {

"uri": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUYAAA==/action",

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUYAAA=="

{

"name": "Calendar",

"type": "Appointment",

"description": "",

"_links": {

"self": {

"children": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

"items": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

"mailbox": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoretoOriginallocation": {

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

...]

Example 2

The following request returns an entity representation of the organization's mailbox folders and subfolders. The server will return a page with 2 elements of the /RestoreSessions/{ID}/Organization/Mailboxes/{ID}/Folders resource. The page will return results starting from the 2nd element.

Request:

GET https://support.east.local:4443/v3/RestoreSessions/0800471b-d0e2-422b-9d7c-35d15661c3fb/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=1&limit=2

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 1,

"limit": 2,

"results": [

{

"name": "ABC",

"type": "None",

"description": "",

"_links": {

"self": {

"parent": {

"children": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACNjMfIAAA=="

"items": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACNjMfIAAA=="

"mailbox": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoretoOriginallocation": {

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACNjMfIAAA=="

{

"name": "Billing",

"type": "None",

"description": "",

"_links": {

"self": {

"parent": {

"children": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACQSRIMAAA=="

"items": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACQSRIMAAA=="

"mailbox": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoretoOriginallocation": {

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACQSRIMAAA=="

}

"_links": {

"first": {

"href": "https://support.east.local:4443/v3/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=0&limit=2"

"prev": {

"href": "https://support.east.local:4443/v3/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=0&limit=2"

"self": {

"href": "https://support.east.local:4443/v3/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=2&limit=2"

"next": {

"href": "https://support.east.local:4443/v3/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=4&limit=2"

}

Example 3

The following request returns an entity representation of the organization's mailbox folders.

Request:

GET https://support.east.local:4443/v3/RestoreSessions/0800471b-d0e2-422b-9d7c-35d15661c3fb/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?parentId=null

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"results": [

{

"name": "Archive",

"type": "None",

"description": "",

"_links": {

"self": {

"children": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAF78ViUAAA=="

"items": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAF78ViUAAA=="

"mailbox": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoretoOriginallocation": {

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAF78ViUAAA=="

{

"name": "Calendar",

"type": "Appointment",

"description": "",

"_links": {

"self": {

"children": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

"items": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

"mailbox": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoretoOriginallocation": {

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

...]

Example 4

The following request returns an entity representation of the organization's mailbox folders and subfolders with names starting from Support.

Request:

GET https://support.east.local:4443/v3/RestoreSessions/0800471b-d0e2-422b-9d7c-35d15661c3fb/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?name=Support*

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"results": [

{

"name": "Support Companies",

"type": "None",

"description": "",

"_links": {

"self": {

"parent": {

"children": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA=="

"items": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA=="

"mailbox": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoretoOriginallocation": {

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA=="

{

"name": "Support Contacts",

"type": "Contact",

"description": "",

"_links": {

"self": {

"children": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

"items": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

"mailbox": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoretoOriginallocation": {

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

...]

Example 5

The following request returns an entity representation of the subfolders of the organization's mailbox folder with ID AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==.

Request:

GET https://support.east.local:4443/v3/RestoreSessions/9f786f0f-de9a-4a90-8118-093b6cb2c4fc/Organization/Mailboxes/{ID}/Folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"results": [

{

"name": "{A9E2BC46-B3A0-4243-B315-60D991004455}",

"type": "None",

"description": "",

"_links": {

"self": {

"parent": {

"children": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAASAAAA=="

"items": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAASAAAA=="

"mailbox": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoretoOriginallocation": {

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAASAAAA=="

{

"name": "Companies",

"type": "None",

"description": "",

"_links": {

"self": {

"parent": {

"children": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA=="

"items": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA=="

"mailbox": {

"href": "https://support.east.local:4443/v3/restoresessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoretoOriginallocation": {

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA=="

...]