Getting Mailbox Folders

In this article

You can get a resource representation of an organization mailbox folder with the specified ID.

Request

GET https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/organization/mailboxes/{mailboxId}/folders/{folderId}

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.
folderId	string	Specifies the identification number of the folder. For more information on how to get this parameter, see Getting Mailbox Folders.

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

The response body contains the following properties:

Property	Type	Description
id	string	Specifies the ID of the organization mailbox folder.
name	string	Specifies the name of the organization mailbox folder.
type	string	Specifies the type of the organization mailbox folder. The following types are available: Journal Task StickyNote Contact Appointment None
category	string	Specifies the category of the organization mailbox folder. The following values are available: Inbox Outbox Sent Deleted Drafts PermanentlyDeletedItems Purges DiscoveryHolds Conflicts SyncIssues LocalFailures ServerFailures Junk Versions TeamsMessagesData None
description	string	Specifies the description of the organization mailbox folder.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).
_actions	Dictionary of string [key] and Object [value]	Links to related actions (navigation property).

Example

The example returns a resource representation of the organization mailbox folder with the ID AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==.

Request:

GET https://abc.tech.local:4443/v6/RestoreSessions/9f786f0f-de9a-4a90-8118-093b6cb2c4fc/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"name": "Support Contacts",

"type": "Contact",

"description": "",

"_links": {

"self": {

"href": "v6/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

"children": {

"href": "v6/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders?parentId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

"items": {

"href": "v6/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/items?folderId=AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

"mailbox": {

"href": "v6/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

}

"_actions": {

"restoreToOriginalLocation": {

"uri": "v6/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/organization/mailboxes/479ae6aa-610b-4652-8966-5db06021903c/folders/AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA==/restore",

"method": "POST"

"restoreTo": {

"method": "POST"

"exporttoPst": {

"method": "POST"

"search": {

"method": "POST"

}

"id": "AAAAAKGE4dIvQUtGjuSnq8JTHAgBAPliTMf_6DxPiJ6TGYB9CqAAAAAAAQ4AAA=="

}