Get /files/v3/folders/search Do Search

Search folders

GET/files/v3/folders/search

Use it in a workflow

Add a step and choose the HubSpot connector.
Pick the Get /files/v3/folders/search Do Search action (under Files).
Fill in the fields below, then reference the result from later steps as {{getFilesV3FoldersSearchDoSearch.response.data}}.

Request

Query parameters

afterstring

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.

beforestring

Search folders updated before this timestamp. Time must be epoch time in milliseconds.

createdAtstring (date-time)

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

createdAtGtestring (date-time)

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

createdAtLtestring (date-time)

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

idGteinteger (int64)

Search folders by greater than or equal to ID. Can be used with idLte to create a range.

idLteinteger (int64)

Search folders by less than or equal to ID. Can be used with idGte to create a range.

idsarray<integer (int64)>

Search folders by multiple IDs. Comma-separated list of folder IDs.

limitinteger (int32)

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

namestring

Search for folders containing the specified name.

parentFolderIdsarray<integer (int64)>

pathstring

Search folders by path.

propertiesarray<string>

Properties that should be included in the returned folders.

sortarray<string>

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

updatedAtstring (date-time)

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

updatedAtGtestring (date-time)

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

updatedAtLtestring (date-time)

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

Response

Returns 200 with an object. Read it in later steps with {{getFilesV3FoldersSearchDoSearch.response.data.<field>}}.

pagingobject

nextobject2 fields

Specifies the paging information needed to retrieve the next set of results in a paginated API response

prevobject2 fields

specifies the paging information needed to retrieve the previous set of results in a paginated API response

resultsarray<object>

archivedbooleanrequired

Marks whether the folder is deleted or not.

archivedAtstring (date-time)

Timestamp of folder deletion.

createdAtstring (date-time)required

Timestamp of folder creation.

idstringrequired

ID of the folder.

namestring

Name of the folder.

parentFolderIdstring

ID of the parent folder.

pathstring

Path of the folder in the file manager.

updatedAtstring (date-time)required

Timestamp of the latest update to the folder.

json

{
  "results": [
    {
      "archived": false,
      "createdAt": "2025-01-01T00:00:00Z",
      "id": "string",
      "updatedAt": "2025-01-01T00:00:00Z",
      "archivedAt": "2025-01-01T00:00:00Z",
      "name": "string",
      "parentFolderId": "string",
      "path": "string"
    }
  ],
  "paging": {
    "next": {
      "after": "string",
      "link": "string"
    },
    "prev": {
      "before": "string",
      "link": "string"
    }
  }
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.

Was this page helpful?