Getting Mailboxes

In this article

    You can get a resource representation of a specific organization's mailbox to explore and restore data.

    Request

    GET https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Organization/Mailboxes/{mailboxId}

    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.

    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 contains the following information:

    Property

    Type

    Description

    id

    string

    Specifies the ID of the organization's backed-up mailbox.

    email

    string

    Specifies the email address of the organization's backed-up mailbox.

    name

    string

    Specifies the name of the organization's backed-up mailbox.

    isArchive

    boolean

    If set to true, indicates that archiving is enabled for this backed-up mailbox. Archiving can be enabled or disabled in an Exchange organization.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Examples

    Example 1

    The following request returns a resource representation of the organization's mailbox with the ID 9f786f0f-de9a-4a90-8118-093b6cb2c4fc.

    Request:

    GET https://abc.tech.local:4443/v5/RestoreSessions/9f786f0f-de9a-4a90-8118-093b6cb2c4fc/Organization/Mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "id": "9e9b7199-f547-467a-b580-9d283a75eaad",

     "name": "support.south",

     "email": "support.south@westsupport.com",

     "isArchive": false,

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad"

       },

       "folders": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/folders?parentId=null"

       },

       "allfolders": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/folders"

       },

       "items": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/items"

       }

     },

     "_actions": {

       "restoretoOriginallocation": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/action",

         "method": "POST"

       },

       "restoreTo": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/action",

         "method": "POST"

       },

       "exporttoPst": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/action",

         "method": "POST"

       },

       "search": {

         "uri": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/9e9b7199-f547-467a-b580-9d283a75eaad/action",

         "method": "POST"

       }

     }

    }