Getting Organization Groups

This section explains how to get a resource representation of organization groups.

Request

GET https://<hostname>:4443/v4/Organizations/{organizationId}/Groups

Request Headers

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

Request Parameters

The following parameters must be posted as URL.

Parameter

Type

Description

organizationId

string

An identification number of the organization.

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 representation of the /Organizations/{organizationId}/Groups resource.

Example

Request:

GET https://abc.tech.local:4443/v4/Organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/Groups

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

[

 {

 "offset": 0,

 "limit": 30,

 "results": [

   {

     "id": "16f8226c-9531-4ed2-9b87-856f7c76a42600000000-0000-0000-0000-000000000000",

     "displayName": "Site",

     "name": "Site@backup.onmicrosoft.com",

     "managedBy": "kate.rourke",

     "site": "https://backup.sharepoint.com/sites/Site",

     "type": "Office365",

     "locationType": "Cloud",

     "isBackedup": false,

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v4/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e/groups/16f8226c-9531-4ed2-9b87-856f7c76a42600000000-0000-0000-0000-000000000000"

       },

       "organization": {

         "href": "https://abc.tech.local:4443/v4/organizations/92460656-7a85-4a04-b1af-1ea903c0bc2e"

       }

     }

   },

…]

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.