Method Details
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing & CRM
Required Scope:
Get the metadata for the folders in file manager.
There's a new version of the HubSpot API
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing & CRM
Required Scope:
Get the metadata for the folders in file manager.
| Required Parameters | How to use | Description |
|---|---|---|
| OAuth Access Token or API Key | Authorization: Bearer {token} header or hapikey={key} query parameter. |
Used to authenticate the request. Please see this page for more details about authentication. |
| Parameter name | Description |
|---|---|
| limit | The number of items to return. Defaults to 20 |
| offset | The offset set to start returning rows from. Defaults to 0. |
| deleted_at | Get folders deleted on or after a certain date. Available filers are exact, range, gt, gte, lt, lte. Use the parameter followed by two underscores and the filter of choice. For example deleted_at__lt=1431489600000 will return all files deleted before May 15, 2015. Filters take unix timestamps in milliseconds. |
| id | Get a specific folder. |
| name | Get folders with a certain naming convention. Available filters are exact, contains, icontains. Use the paramter followed by two underscores and the filter of choice. For example name__icontains=abc will return all folders that have the characters abc (in a row) in the name. |
| parent_folder_id | Get all folders in a specific folder. Available filers are exact, range, gt, gte, lt, lte. Use the parameter followed by two underscores and the filter of choice. For example parent_folder_id__lte=2857188310 will return all folders with an id less than or equal to 2857188310. |
Hit this URL with a HTTP method of GET http://api.hubapi.com/filemanager/api/v2/folders?hapikey=demo
| Parameter name | Type | Description |
|---|---|---|
| created | long | When the folder was first created, in milliseconds since the epoch |
| deleted_at | long | When the folder was deleted, in milliseconds since the epoch. Zero if the folder was never deleted. Use a DELETE request to delete a folder, do not set this directly. |
| full_path | string | The full path to the folder, with all the parent folder paths included |
| id | string | The unique id of the folder |
| name | string | The name of the folder |
| parent_folder_id | string | The id of the parent folder |
| updated | long | When the folder was last updated, in milliseconds since the epoch |