Method: spaces.messages.attachments.get
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://chat.googleapis.com/v1/{name=spaces/*/messages/*/attachments/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Resource name of the attachment, in the form spaces/{space}/messages/{message}/attachments/{attachment}.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Attachment.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/chat.bot
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-05-07 UTC.
[null,null,["Last updated 2025-05-07 UTC."],[[["\u003cp\u003eRetrieves metadata of a message attachment, with the actual attachment data fetched separately using the media API.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003echat.bot\u003c/code\u003e OAuth scope and app authentication for access.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request to the specified URL with the attachment's resource name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eReturns an \u003ccode\u003eAttachment\u003c/code\u003e object in the response body upon successful execution.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the provided links for a practical example and further details on media download and authorization.\u003c/p\u003e\n"]]],["This describes retrieving message attachment metadata via a `GET` request to `https://chat.googleapis.com/v1/{name=spaces/*/messages/*/attachments/*}`. The `name` parameter, specifying the attachment's resource location, is required. The request body must be empty. A successful response returns an `Attachment` instance. Accessing this data mandates the `https://www.googleapis.com/auth/chat.bot` OAuth scope. The actual attachment data can be downloaded using the linked media API.\n"],null,["# Method: spaces.messages.attachments.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\nGets the metadata of a message attachment. The attachment data is fetched using the [media API](https://developers.google.com/workspace/chat/api/reference/rest/v1/media/download). For an example, see [Get metadata about a message attachment](https://developers.google.com/workspace/chat/get-media-attachments).\n\nRequires [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):\n\n- `https://www.googleapis.com/auth/chat.bot`\n\n### HTTP request\n\n`GET https://chat.googleapis.com/v1/{name=spaces/*/messages/*/attachments/*}`\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 attachment, in the form `spaces/{space}/messages/{message}/attachments/{attachment}`. |\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 [Attachment](/workspace/chat/api/reference/rest/v1/spaces.messages.attachments#Attachment).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/chat.bot`\n\nFor more information, see the [Authorization guide](/workspace/chat/authenticate-authorize)."]]
