Veeam Backup for Microsoft Office 365 5.0 [Archived]
REST API Reference
Related documents
Search
This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Mailbox Folders

You can get a resource representation of organization mailbox folders to explore and restore mailbox folders data.

Request

GET https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Folders[?parentId=<value>]

Request Headers

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

Request Parameters

The following parameters must be specified in the URL of the request:

Parameter

Type

Description

restoreSessionId

string

Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions.

mailboxId

string

Specifies the identification number of the mailbox. For more information on how to get this parameter, see Getting Mailboxes.

The following optional parameter can be specified in the URL of the request:

Parameter

Type

Description

parentId

string

Specifies what information the server will return in the resource representation. Possible values:

  • <parentID> — ID of the parent mailbox folder. In the response, the server will return a representation of subfolders for the specified mailbox folder.
  • null — specifies that the server will return a representation of all root folders of the mailbox without their subfolders.

If you do not specify this parameter, the server will return a representation of all parent folders of the mailbox and their subfolders. Thus, the server will require longer time to execute the request.

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 /RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}/Folders resource.

Examples

Example 1

The following request returns a resource 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/{mailboxId}/Folders resource collection.

Request:

GET https://abc.tech.local:4443/v5/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://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUYAAA=="

       },

       "parent": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

       },

       "children": {

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

       },

       "items": {

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

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

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

         "method": "POST"

       },

       "restoreTo": {

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

         "method": "POST"

       },

       "exporttoPst": {

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

         "method": "POST"

       },

       "search": {

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

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUYAAA=="

   },

   {

     "name": "Calendar",

     "type": "Appointment",

     "description": "",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

       },

       "children": {

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

       },

       "items": {

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

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA==/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA==/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA==/action",

         "method": "POST"

       },

       "search": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA==/action",

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

   },

..]

Example 2

The following request returns a resource 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://abc.tech.local:4443/v5/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": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACNjMfIAAA=="

       },

       "parent": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQwAAA=="

       },

       "children": {

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

       },

       "items": {

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

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACNjMfIAAA==/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACNjMfIAAA==/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACNjMfIAAA==/action",

         "method": "POST"

       },

       "search": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACNjMfIAAA==/action",

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACNjMfIAAA=="

   },

   {

     "name": "Billing",

     "type": "None",

     "description": "",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACQSRIMAAA=="

       },

       "parent": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQwAAA=="

       },

       "children": {

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

       },

       "items": {

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

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACQSRIMAAA==/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACQSRIMAAA==/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACQSRIMAAA==/action",

         "method": "POST"

       },

       "search": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACQSRIMAAA==/action",

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAACQSRIMAAA=="

   }

 ],

 "_links": {

   "first": {

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

   },

   "prev": {

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

   },

   "self": {

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

   },

   "next": {

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

   }

 }

}

Example 3

The following request returns a resource representation of the organization's mailbox folders.

Request:

GET https://abc.tech.local:4443/v5/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": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAF78ViUAAA=="

       },

       "children": {

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

       },

       "items": {

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

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAF78ViUAAA==/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAF78ViUAAA==/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAF78ViUAAA==/action",

         "method": "POST"

       },

       "search": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAF78ViUAAA==/action",

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAF78ViUAAA=="

   },

   {

     "name": "Calendar",

     "type": "Appointment",

     "description": "",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

       },

       "children": {

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

       },

       "items": {

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

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA==/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA==/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA==/action",

         "method": "POST"

       },

       "search": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA==/action",

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ0AAA=="

   },

..]

Example 4

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

Request:

GET https://abc.tech.local:4443/v5/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": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA=="

       },

       "parent": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

       },

       "children": {

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

       },

       "items": {

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

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA==/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA==/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA==/action",

         "method": "POST"

       },

       "search": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA==/action",

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA=="

   },

   {

     "name": "Support Contacts",

     "type": "Contact",

     "description": "",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

       },

       "children": {

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

       },

       "items": {

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

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==/action",

         "method": "POST"

       },

       "search": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==/action",

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

   },

..]

Example 5

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

Request:

GET https://abc.tech.local:4443/v5/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": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAASAAAA=="

       },

       "parent": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

       },

       "children": {

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

       },

       "items": {

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

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAASAAAA==/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAASAAAA==/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAASAAAA==/action",

         "method": "POST"

       },

       "search": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAASAAAA==/action",

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAASAAAA=="

   },

   {

     "name": "Companies",

     "type": "None",

     "description": "",

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA=="

       },

       "parent": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

       },

       "children": {

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

       },

       "items": {

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

       },

       "mailbox": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA==/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA==/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA==/action",

         "method": "POST"

       },

       "search": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA==/action",

         "method": "POST"

       }

     },

     "id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAUQAAA=="

   },

..]

View all results across Veeam
Back to document search