Getting Organization Groups by Organization and Group ID

In this article

    You can get a resource representation of an organization group with the specified ID.

    Request

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

    Request Headers

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

    Request Parameters

    The following parameters must be specified in the URL of the request:

    Parameter

    Type

    Description

    organizationId

    string

    Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Getting Organizations.

    groupId

    string

    Specifies the identification number of the group. For more information on how to get this parameter, see Getting Organization Groups.

    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/{organizationId}/Groups/{groupId} resource. The response body contains the following properties:

    Property

    Type

    Description

    id

    string

    Specifies the organization group ID.

    displayName

    string

    Specifies a display name of the organization group.

    name

    string

    Specifies a name of the organization group.

    managedBy

    string

    Specifies information about a user who manages the organization group.

    site

    string

    Specifies a site of the organization group.

    type

    string

    Specifies the organization group type. The following types are available:

    • Office365
    • Security
    • Distribution
    • DynamicDistribution

    locationType

    string

    Specifies the Microsoft 365 organization deployment type. The following types are available:

    • OnPremises
    • Cloud
    • Hybrid

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    The example returns a resource representation of the organization group with the ID 0eb7e684-b568-4487-8fe5-1c92cd13e91500000000-0000-0000-0000-000000000000.

    Request:

    GET https://abc.tech.local:4443/v6/Organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/Groups/0eb7e684-b568-4487-8fe5-1c92cd13e91500000000-0000-0000-0000-000000000000

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "id": "0eb7e684-b568-4487-8fe5-1c92cd13e91500000000-0000-0000-0000-000000000000",

     "displayName": "Group2",

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

     "managedBy": "administrator",

     "site": "https://abc.sharepoint.com/sites/group2",

     "type": "Office365",

     "locationType": "Cloud",

     "_links": {

       "self": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/groups/0eb7e684-b568-4487-8fe5-1c92cd13e91500000000-0000-0000-0000-000000000000"

       },

       "organization": {

         "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b"

       }

     }

    }