Method: enterprises.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists EMM-managed enterprises. Only BASIC fields are returned.
HTTP request
GET https://androidmanagement.googleapis.com/v1/enterprises
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
projectId |
string
Required. The Cloud project ID of the EMM managing the enterprises.
|
pageSize |
integer
The requested page size. The actual page size may be fixed to a min or max value.
|
pageToken |
string
A token identifying a page of results returned by the server.
|
view |
enum (EnterpriseView)
Specifies which Enterprise fields to return. This method only supports BASIC.
|
Request body
The request body must be empty.
Response body
Response to a request to list enterprises.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"enterprises": [
{
object (Enterprise)
}
],
"nextPageToken": string
} |
| Fields |
enterprises[] |
object (Enterprise)
The list of enterprises.
|
nextPageToken |
string
If there are more results, a token to retrieve next page of results.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidmanagement
For more information, see the OAuth 2.0 Overview.
EnterpriseView
Specifies which Enterprise fields to return.
| Enums |
ENTERPRISE_VIEW_UNSPECIFIED |
The API will default to the BASIC view for the List method. |
BASIC |
Includes name and enterpriseDisplayName fields. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-19 UTC.
[null,null,["Last updated 2025-02-19 UTC."],[[["\u003cp\u003eLists EMM-managed enterprises, returning only basic fields like name and display name.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/androidmanagement\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by Cloud project ID and pagination for large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequest body should be empty, and the response includes a list of enterprises and a token for pagination.\u003c/p\u003e\n"],["\u003cp\u003eUses a GET request to the \u003ccode\u003ehttps://androidmanagement.googleapis.com/v1/enterprises\u003c/code\u003e endpoint.\u003c/p\u003e\n"]]],["This document details how to list EMM-managed enterprises via a `GET` request to `https://androidmanagement.googleapis.com/v1/enterprises`. The request requires a `projectId`, and supports optional `pageSize`, `pageToken`, and `view` query parameters. The `view` parameter only supports `BASIC`. The request body must be empty. The response includes a list of enterprises, with a `nextPageToken` for pagination. Authentication requires the `https://www.googleapis.com/auth/androidmanagement` OAuth scope.\n"],null,["# Method: enterprises.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListEnterprisesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [EnterpriseView](#EnterpriseView)\n- [Try it!](#try-it)\n\nLists EMM-managed enterprises. Only [BASIC](/android/management/reference/rest/v1/enterprises/list#EnterpriseView.ENUM_VALUES.BASIC) fields are returned.\n\n### HTTP request\n\n`GET https://androidmanagement.googleapis.com/v1/enterprises`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `projectId` | `string` Required. The Cloud project ID of the EMM managing the enterprises. |\n| `pageSize` | `integer` The requested page size. The actual page size may be fixed to a min or max value. |\n| `pageToken` | `string` A token identifying a page of results returned by the server. |\n| `view` | `enum (`[EnterpriseView](/android/management/reference/rest/v1/enterprises/list#EnterpriseView)`)` Specifies which Enterprise fields to return. This method only supports [BASIC](/android/management/reference/rest/v1/enterprises/list#EnterpriseView.ENUM_VALUES.BASIC). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse to a request to list enterprises.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"enterprises\": [ { object (/android/management/reference/rest/v1/enterprises#Enterprise) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------|\n| `enterprises[]` | `object (`[Enterprise](/android/management/reference/rest/v1/enterprises#Enterprise)`)` The list of enterprises. |\n| `nextPageToken` | `string` If there are more results, a token to retrieve next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidmanagement`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nEnterpriseView\n--------------\n\nSpecifies which Enterprise fields to return.\n\n| Enums ||\n|-------------------------------|-------------------------------------------------------------|\n| `ENTERPRISE_VIEW_UNSPECIFIED` | The API will default to the BASIC view for the List method. |\n| `BASIC` | Includes name and enterpriseDisplayName fields. |"]]
