To see an example of how to include query parameters in a request, see the
JSON API Overview page.
Parameters
Parameter name
Value
Description
Path parameters
bucket
string
The parent bucket of the folder.
folder
string
The URL-encoded name of the folder. For example,
example-folder/ URL-encoded as example-folder%2F. If the folder
is nested, for example, example-folder1/example-folder2/, then the URL-encoded name is example-folder1%2Fexample-folder2%2F.
Optional query parameters
ifMetagenerationMatch
long
If set, the method returns the folder if its metageneration matches this value.
ifMetagenerationNotMatch
long
If set, the method returns the folder if its metageneration does not match this value.
Request body
Don't supply a request body with this method.
Response
If successful, this method returns a folder
resource in the response body.
For information about status and error codes returned by this API, see the
reference page.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Folder: get\n\nRetrieves [metadata of a folder](/storage/docs/json_api/v1/folders#resource) within a bucket with hierarchical namespace enabled.\n\nRequired permissions\n--------------------\n\nThe authenticated user must have the `storage.folders.get`\nIAM permission to use this method.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://storage.googleapis.com/storage/v1/b/bucket/folders/folder\n```\n\nIn addition to [standard query parameters](/storage/docs/json_api/v1/parameters#query),\nthe following parameters apply to this method.\n\nTo see an example of how to include query parameters in a request, see the\n[JSON API Overview](/storage/docs/json_api#query_parameters) page.\n\n### Parameters\n\n### Request body\n\nDon't supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a [folder\nresource](/storage/docs/json_api/v1/folders#resource) in the response body.\n\nFor information about status and error codes returned by this API, see the\n[reference page](/storage/docs/json_api/v1/status-codes).\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]
