Getting Teams

This section explains how to get a resource representation of teams to explore and restore Microsoft Teams data.

Request

GET https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/organization/teams[?displayName=<value>]

Request Headers

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

Request Parameters

The following optional parameter can be specified in the URL of the request.

Parameter

Type

Description

displayName

string

Specifies the display name of the teams whose representation you want to get from the server. The server will return a representation of the teams whose display name contains the value that you specified for this parameter.

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 /RestoreSessions/{restoreSessionId}/organization/teams resource.

Example 1

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

Request:

GET https://abc.tech.local:4443/v5/RestoreSessions/1016c007-fe65-4f25-9d71-cc7ea387b3dc/organization/teams

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

   {

     "id": "448c5b66-8dcd-4c75-b636-d3b500bce36f",

     "displayName": "IT&Finance",

     "description": "IT&Finance",

     "groupEmail": "IT&Finance@abc.onmicrosoft.com",

     "alias": "IT&Finance",

     "privacy": "Public",

     "isArchived": false,

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/1016c007-fe65-4f25-9d71-cc7ea387b3dc/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f"

       },

       "channels": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/1016c007-fe65-4f25-9d71-cc7ea387b3dc/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels"

       }

     }

   },

   {

     "id": "ef9eb317-0478-45b7-bf58-cc12e2088bef",

     "displayName": "Team",

     "description": "Team",

     "groupEmail": "Team@abc.onmicrosoft.com",

     "alias": "TeamWith100Channels",

     "privacy": "Public",

     "isArchived": false,

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/1016c007-fe65-4f25-9d71-cc7ea387b3dc/organization/teams/ef9eb317-0478-45b7-bf58-cc12e2088bef"

       },

       "channels": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/1016c007-fe65-4f25-9d71-cc7ea387b3dc/organization/teams/ef9eb317-0478-45b7-bf58-cc12e2088bef/channels"

       }

     }

   },

   {

     "id": "a21a2761-c664-4e9c-9c3b-592ffb5ee3bf",

     "displayName": "All",

     "description": "A lot of tabs (word, excel, powepoint, pdf, website, document library)",

     "groupEmail": "All@abc.onmicrosoft.com",

     "alias": "AllTabs",

     "privacy": "Public",

     "isArchived": false,

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/1016c007-fe65-4f25-9d71-cc7ea387b3dc/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf"

       },

       "channels": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/1016c007-fe65-4f25-9d71-cc7ea387b3dc/organization/teams/a21a2761-c664-4e9c-9c3b-592ffb5ee3bf/channels"

       }

     }

   }

 ],

 "_links": {

   "self": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/1016c007-fe65-4f25-9d71-cc7ea387b3dc/organization/teams?offset=0&limit=30"

   }

 }

}

Example 2

The following request returns a representation of the organization's teams whose names match the specified value.

Request:

GET https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams?displayName=IT

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

   {

     "id": "448c5b66-8dcd-4c75-b636-d3b500bce36f",

     "displayName": "IT&Finance",

     "description": "IT&Finance",

     "groupEmail": "IT&Finance@abc.onmicrosoft.com",

     "alias": "IT&Finance",

     "privacy": "Public",

     "isArchived": false,

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f"

       },

       "channels": {

         "href": "https://abc.tech.local:4443/v5/restoresessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams/448c5b66-8dcd-4c75-b636-d3b500bce36f/channels"

       }

     }

   }

 ],

 "_links": {

   "self": {

     "href": "https://abc.tech.local:4443/v5/RestoreSessions/e9921c25-6845-4c6f-a913-bc03b712483a/organization/teams?displayname=IT&offset=0&limit=30"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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