This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Organizations

You can get a resource representation of all organizations added to Veeam Backup for Microsoft 365.

Request

GET https://<hostname>:4443/v6/Organizations?extendedView=<boolean>

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

extendedView

boolean

Defines the representation of the organization properties that will be returned to the client. The following values are available:

  • true — controller requests the proxy server and if the proxy server is online, returns all properties of the organization.
  • false — even if the proxy server is offline, the controller returns the organization properties without the following properties:
  • isBackedup
  • firstBackuptime
  • lastBackuptime

The default value is true.

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 /Organizations collection resource.

Example

The example returns a resource representation of all organizations added to Veeam Backup for Microsoft 365.

Request:

GET https://abc.tech.local:4443/v6/Organizations?extendedView=true

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

[

 {

   "isTeamsOnline": true,

   "isTeamsChatsOnline": true,

   "exchangeOnlineSettings": {

     "useApplicationOnlyAuth": true,

     "officeOrganizationName": "abc.onmicrosoft.com",

     "account": "admin@abc.onmicrosoft.com",

     "grantAdminAccess": true,

     "useMfa": true,

     "applicationId": "a1cc0b32-c468-49a7-b4da-945927135cf2",

     "applicationCertificateThumbprint": "4827CDE8F66C1E34A51B50644C67012BA5B07BE9"

   },

   "sharePointOnlineSettings": {

     "useApplicationOnlyAuth": true,

     "officeOrganizationName": "abc.onmicrosoft.com",

     "sharePointSaveAllWebParts": false,

     "account": "admin@abc.onmicrosoft.com",

     "grantAdminAccess": true,

     "useMfa": true,

     "applicationId": "a1cc0b32-c468-49a7-b4da-945927135cf2",

     "applicationCertificateThumbprint": "4827CDE8F66C1E34A51B50644C67012BA5B07BE9"

   },

   "isExchangeOnline": true,

   "isSharePointOnline": true,

   "type": "Office365",

   "region": "Worldwide",

   "id": "40dfa255-2762-43e5-8320-dff7a9201f90",

   "name": "abc.onmicrosoft.com",

   "officeName": "abc.onmicrosoft.com",

   "isBackedup": true,

   "firstBackuptime": "2020-10-14T14:14:15.8178322Z",

   "lastBackuptime": "2020-12-10T22:01:39.3183856Z",

   "_links": {

     "self": {

       "href": "/v6/organizations/40dfa255-2762-43e5-8320-dff7a9201f90"

     },

     "jobs": {

       "href": "/v6/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/jobs"

     },

     "groups": {

       "href": "/v6/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/groups"

     },

     "users": {

       "href": "/v6/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/users"

     },

     "sites": {

       "href": "/v6/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/sites"

     },

     "teams": {

       "href": "/v6/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/teams"

     },

     "usedRepositories": {

       "href": "/v6/organizations/40dfa255-2762-43e5-8320-dff7a9201f90/usedRepositories"

     }

   },

   "_actions": {}

 }

]