Important: We are no longer accepting new registrations for the Play EMM API.
Learn more.
Enterprises: list
Stay organized with collections
Save and categorize content based on your preferences.
Looks up an enterprise by domain name.
This is only supported for enterprises created via the Google-initiated
creation flow. Lookup of the id is not needed for enterprises created via
the EMM-initiated flow since the EMM learns the enterprise ID in the
callback specified in the Enterprises.generateSignupUrl call.
Request
HTTP request
GET https://www.googleapis.com/androidenterprise/v1/enterprises
Parameters
| Parameter name |
Value |
Description |
| Required query parameters |
domain |
string |
The exact primary domain name of the enterprise to look up.
|
Authorization
This request requires authorization with the following scope:
| Scope |
|---|
https://www.googleapis.com/auth/androidenterprise |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{
"kind": "androidenterprise#enterprisesListResponse",
"enterprise": [
enterprises Resource
]
}
| Property name |
Value |
Description |
Notes |
enterprise[] |
list |
An enterprise. |
|
kind |
string |
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#enterprisesListResponse". |
|
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 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eLocates an enterprise using its domain name, specifically for those created through Google's process.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidenterprise\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made using an HTTP GET to the URL \u003ccode\u003ehttps://www.googleapis.com/androidenterprise/v1/enterprises\u003c/code\u003e with the domain name as a required query parameter.\u003c/p\u003e\n"],["\u003cp\u003ePrimarily used for enterprises created via the Google-initiated creation flow; enterprises created via EMM-initiated flow already possess the enterprise ID.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful execution, the response provides an \u003ccode\u003eenterprisesListResponse\u003c/code\u003e containing details of the located enterprise.\u003c/p\u003e\n"]]],[],null,["# Enterprises: list\n\n| **Note:** Requires [authorization](#auth).\n\nLooks up an enterprise by domain name.\nThis is only supported for enterprises created via the Google-initiated\ncreation flow. Lookup of the id is not needed for enterprises created via\nthe EMM-initiated flow since the EMM learns the enterprise ID in the\ncallback specified in the Enterprises.generateSignupUrl call.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/androidenterprise/v1/enterprises\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|-------------------------------------------------------------|\n| **Required query parameters** |||\n| `domain` | `string` | The exact primary domain name of the enterprise to look up. |\n\n### Authorization\n\nThis request requires authorization with the following scope:\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/androidenterprise` |\n\nFor more information, see the [authentication and authorization](/android/work/play/emm-api/v1/how-tos/authorizing) page.\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"kind\": \"androidenterprise#enterprisesListResponse\",\n \"enterprise\": [\n enterprises Resource\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|----------------|----------|------------------------------------------------------------------------------------------------------------------|-------|\n| `enterprise[]` | `list` | An enterprise. | |\n| `kind` | `string` | Identifies what kind of resource this is. Value: the fixed string `\"androidenterprise#enterprisesListResponse\"`. | |"]]