Method: subscriptions.get
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://workspaceevents.googleapis.com/v1beta/{name=subscriptions/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Resource name of the subscription. Format: subscriptions/{subscription}
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Subscription.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/chat.bot
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
https://www.googleapis.com/auth/chat.messages.reactions
https://www.googleapis.com/auth/chat.messages.reactions.readonly
https://www.googleapis.com/auth/chat.memberships
https://www.googleapis.com/auth/chat.memberships.readonly
https://www.googleapis.com/auth/meetings.space.created
https://www.googleapis.com/auth/meetings.space.readonly
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.readonly
For more information, see the Authorization guide.
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-07-07 UTC.
[null,null,["Last updated 2025-07-07 UTC."],[[["\u003cp\u003eThis method retrieves details about a specific Google Workspace subscription, providing information like its configuration and status.\u003c/p\u003e\n"],["\u003cp\u003eAn HTTP GET request is made to a specific URL, requiring the subscription's resource name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, and a successful response includes a \u003ccode\u003eSubscription\u003c/code\u003e object containing the subscription's details.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is necessary using one of the listed OAuth scopes, which grant access to various Chat and Meetings features depending on the chosen scope.\u003c/p\u003e\n"],["\u003cp\u003eThis feature is currently in Developer Preview and available through the Google Workspace Developer Preview Program.\u003c/p\u003e\n"]]],["This API method retrieves details about a Google Workspace subscription using a `GET` request to the specified URL. The required `name` parameter, formatted as `subscriptions/{subscription}`, is included in the URL path. The request body must be empty. A successful response returns a `Subscription` object. The method needs one of the listed OAuth scopes, related to chat and meeting spaces, for authorization. This feature is available as part of the Google Workspace Developer Preview Program.\n"],null,["# Method: subscriptions.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](/workspace/preview), which grants early access to certain features.\n\nGets details about a Google Workspace subscription. To learn how to use this method, see [Get details about a Google Workspace subscription](https://developers.google.com/workspace/events/guides/get-subscription).\n\n### HTTP request\n\n`GET https://workspaceevents.googleapis.com/v1beta/{name=subscriptions/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Resource name of the subscription. Format: `subscriptions/{subscription}` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Subscription](/workspace/events/reference/rest/v1beta/subscriptions#Subscription).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.bot`\n- `\n https://www.googleapis.com/auth/chat.spaces`\n- `\n https://www.googleapis.com/auth/chat.spaces.readonly`\n- `\n https://www.googleapis.com/auth/chat.messages`\n- `\n https://www.googleapis.com/auth/chat.messages.readonly`\n- `\n https://www.googleapis.com/auth/chat.messages.reactions`\n- `\n https://www.googleapis.com/auth/chat.messages.reactions.readonly`\n- `\n https://www.googleapis.com/auth/chat.memberships`\n- `\n https://www.googleapis.com/auth/chat.memberships.readonly`\n- `\n https://www.googleapis.com/auth/meetings.space.created`\n- `\n https://www.googleapis.com/auth/meetings.space.readonly`\n- `\n https://www.googleapis.com/auth/drive`\n- `\n https://www.googleapis.com/auth/drive.file`\n- `\n https://www.googleapis.com/auth/drive.metadata`\n- `\n https://www.googleapis.com/auth/drive.metadata.readonly`\n- `\n https://www.googleapis.com/auth/drive.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
