GET
/
files
/
v3
/
folders
/
search
Search folders
curl --request GET \
  --url https://api.hubapi.com/files/v3/folders/search \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    },
    "prev": {
      "before": "",
      "link": ""
    }
  },
  "results": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "path": "<string>",
      "archived": true,
      "parentFolderId": "<string>",
      "name": "<string>",
      "id": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubStarter

​
Required Scopes

This API requires one of the following scopes:
  • files.ui_hidden.read
  • files

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
properties
string[]

Properties that should be included in the returned folders.

​
after
string

Offset search results by this value. The default offset is 0 and the maximum offset of items for a given search is 10,000. Narrow your search down if you are reaching this limit.

​
before
string
​
limit
integer

Number of items to return. Default limit is 10, maximum limit is 100.

​
sort
string[]

Sort results by given property. For example -name sorts by name field descending, name sorts by name field ascending.

​
ids
integer[]
​
idLte
integer
​
idGte
integer
​
createdAt
string<date-time>

Search folders by exact time of creation. Time must be epoch time in milliseconds.

​
createdAtLte
string<date-time>

Search folders by less than or equal to time of creation. Can be used with createdAtGte to create a range.

​
createdAtGte
string<date-time>

Search folders by greater than or equal to time of creation. Can be used with createdAtLte to create a range.

​
updatedAt
string<date-time>

Search folders by exact time of latest updated. Time must be epoch time in milliseconds.

​
updatedAtLte
string<date-time>

Search folders by less than or equal to time of latest update. Can be used with updatedAtGte to create a range.

​
updatedAtGte
string<date-time>

Search folders by greater than or equal to time of latest update. Can be used with updatedAtLte to create a range.

​
name
string

Search for folders containing the specified name.

​
path
string

Search folders by path.

​
parentFolderIds
integer[]

Search folders with the given parent folderId.

Response

200
application/json

successful operation

The response is of type object.