Getting Organization Groups
You can get a resource representation of an organization groups.
Request
GET https://<hostname>:4443/v6/Organizations/{organizationId}/Groups?displayName=<string>&groupName=<string>&locationFilter=<string> |
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 |
|---|---|---|
organizationId | string | Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Getting Organizations. |
The following optional parameters can be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
displayName | string | Specifies a display name of the organization group. |
groupName | string | Specifies a name of the organization group. |
locationFilter | string | Note: Use this parameter for organizations of the Hybrid type. Specifies an organization group location type. The following types are available:
|
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 collection resource.
Example
The example returns a list of organization groups for an organization with the specified ID.
Request: GET https://abc.tech.local:4443/v6/Organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/Groups
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "offset": 0, "limit": 30, "_links": { "self": { "href": "/v6/Organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/Groups?offset=0&limit=30&setid=31cbc95f-4c1b-4d69-b437-4c6e05e17d0a" }, "next": { "href": "/v6/Organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/Groups?offset=30&limit=30&setid=31cbc95f-4c1b-4d69-b437-4c6e05e17d0a" } }, "results": [ { "id": "46e433c0-4ecc-4ddb-ae34-f2820499fd0600000000-0000-0000-0000-000000000000", "displayName": "Group1", "name": "group1@abc.onmicrosoft.com", "managedBy": "", "type": "Security", "locationType": "Cloud", "_links": { "self": { "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b/groups/46e433c0-4ecc-4ddb-ae34-f2820499fd0600000000-0000-0000-0000-000000000000" }, "organization": { "href": "/v6/organizations/e60dfb9c-ac58-4463-879f-9855ac35576b" } } }, { "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" } } }, … } ], "setId": "31cbc95f-4c1b-4d69-b437-4c6e05e17d0a" } |