Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
RESTful API Reference

(GET) /Organizations/{ID}/Mailboxes

Returns a resource representation of а collection of all mailboxes of the Exchange organization.

Request

To get a resource representation of the mailboxes of the organization added to Veeam Backup for Microsoft Office 365, send the GET HTTPS request to the URL of the /Organizations/{ID}/Mailboxes resource:

HTTPS Request

GET https://<Backup-Office365>:<Port>/v1/Organizations/{ID}/Mailboxes

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 /Organization/{ID}/Mailboxes resource.

Example 1

The following request returns an entity representation of the mailboxes of the organization added to Veeam Backup for Microsoft Office 365.

Request:

GET https://support.east.local:4443/v1/Organizations/{ID}/Mailboxes

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

   {

    "id": "f7a2aa8a-fb84-4444-9e98-ed04609bef45",

     "email": "bsommers@eastsupport.onmicrosoft.com",

     "name": "BillSommers",

     "isBackedup": "true",

     "_links": {

       "self": {

         "href": "https://support.east.local:4443/v1/Organizations/b2d9414d-c417-4a94-be3b-b38a3c2e8a7b/Mailboxes/f7a2aa8a-fb84-4444-9e98-ed04609bef45"

       },

       "organization": {

         "href": "https://support.east.local:4443/v1/Organizations/b2d9414d-c417-4a94-be3b-b38a3c2e8a7b"

       }

     }

   },

   {

     "id": "7b0cdcfb-40ff-44e2-b491-e80fc5cc6d26",

     "email": "pgraham@eastsupport.onmicrosoft.com",

     "name": "Paul Graham",

     "isBackedup": "true",

     "_links": {

       "self": {

         "href": "https://support.east.local:4443/v1/Organizations/b2d9414d-c417-4a94-be3b-b38a3c2e8a7b/Mailboxes/7b0cdcfb-40ff-44e2-b491-e80fc5cc6d26"

       },

       "organization": {

         "href": "https://support.east.local:4443/v1/Organizations/b2d9414d-c417-4a94-be3b-b38a3c2e8a7b"

       }

     }

   },

   {

     "id": "4a019818-3659-44c7-8914-b91c90ded5c7",

     "email": "smunez@eastsupport.onmicrosoft.com",

     "name": "Santiago Munez",

     "isBackedup": "true",

     "_links": {

       "self": {

         "href": "https://support.east.local:4443/v1/Organizations/b2d9414d-c417-4a94-be3b-b38a3c2e8a7b/Mailboxes/4a019818-3659-44c7-8914-b91c90ded5c7"

       },

       "organization": {

         "href": "https://support.east.local:4443/v1/Organizations/b2d9414d-c417-4a94-be3b-b38a3c2e8a7b"

       }

     }

   },

...]

Example 2

The following request returns an entity representation of the mailbox with the name "Bill Sommers".

Request:

GET https://support.east.local:4443/v1/Organizations/{ID}/Mailboxes?name=*BillSommers*

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

   {

    "id": "f7a2aa8a-fb84-4444-9e98-ed04609bef45",

     "email": "bsommers@eastsupport.onmicrosoft.com",

     "name": "Bill Sommers",

     "isBackedup": "true",

     "_links": {

       "self": {

         "href": "https://support.east.local:4443/v1/Organizations/b2d9414d-c417-4a94-be3b-b38a3c2e8a7b/Mailboxes/f7a2aa8a-fb84-4444-9e98-ed04609bef45"

       },

       "organization": {

         "href": "https://support.east.local:4443/v1/Organizations/b2d9414d-c417-4a94-be3b-b38a3c2e8a7b"

       }

     }

   }

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference