Veeam Backup for Microsoft Office 365 5.0
REST API Reference
Related documents
Search

Getting Mailboxes

In this article

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

    Request

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

    Request Headers

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

    Request Parameters

    The following parameter 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.

    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 resource.

    Examples

    Example 1

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

    Request:

    GET https://abc.tech.local:4443/v5/RestoreSessions/0800471b-d0e2-422b-9d7c-35d15661c3fb/Organization/Mailboxes

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "offset": 0,

     "limit": 30,

     "results": [

       {

         "id": "7a619cf6-b7e1-4141-951b-960a2fca061d",

         "name": "support_north",

         "email": "support_north@westsupport.onmicrosoft.com",

         "isArchive": false,

         "_links": {

           "self": {

             "href": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/7a619cf6-b7e1-4141-951b-960a2fca061d"

           },

           "folders": {

             "href": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/7a619cf6-b7e1-4141-951b-960a2fca061d/folders?parentId=null"

           },

           "allfolders": {

             "href": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/7a619cf6-b7e1-4141-951b-960a2fca061d/folders"

           },

           "items": {

             "href": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/7a619cf6-b7e1-4141-951b-960a2fca061d/items"

           }

         },

         "_actions": {

           "restoretoOriginallocation": {

             "uri": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/7a619cf6-b7e1-4141-951b-960a2fca061d/action",

             "method": "POST"

           },

           "restoreTo": {

             "uri": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/7a619cf6-b7e1-4141-951b-960a2fca061d/action",

             "method": "POST"

           },

           "exporttoPst": {

             "uri": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/7a619cf6-b7e1-4141-951b-960a2fca061d/action",

             "method": "POST"

           },

           "search": {

             "uri": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes/7a619cf6-b7e1-4141-951b-960a2fca061d/action",

             "method": "POST"

           }

         }

       },

       {

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

         "name": "support.south",

         "email": "support.south@onmicrosoft.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"

           }

         }

       }

     ],

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/RestoreSessions/8dd690ce-7dd8-4a8b-a6ec-16bdcb04dc97/organization/mailboxes?offset=0&limit=30"

       }

     }

    }

    ..]

    View all results across Veeam
    Back to document search