curl --request GET \
--url https://api.hubapi.com/files/v3/files/search \
--header 'Authorization: Bearer <token>'{
"results": [
{
"access": "HIDDEN_INDEXABLE",
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"defaultHostingUrl": "<string>",
"encoding": "<string>",
"expiresAt": 123,
"extension": "<string>",
"fileMd5": "<string>",
"height": 123,
"isUsableInContent": true,
"name": "<string>",
"parentFolderId": "<string>",
"path": "<string>",
"size": 123,
"sourceGroup": "CONTENT",
"type": "<string>",
"url": "<string>",
"width": 123
}
],
"paging": {
"next": {
"after": "<string>",
"link": "<string>"
},
"prev": {
"before": "<string>",
"link": "<string>"
}
}
}Search files
Search through files in the file manager. Does not display hidden or archived files.
curl --request GET \
--url https://api.hubapi.com/files/v3/files/search \
--header 'Authorization: Bearer <token>'{
"results": [
{
"access": "HIDDEN_INDEXABLE",
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"defaultHostingUrl": "<string>",
"encoding": "<string>",
"expiresAt": 123,
"extension": "<string>",
"fileMd5": "<string>",
"height": 123,
"isUsableInContent": true,
"name": "<string>",
"parentFolderId": "<string>",
"path": "<string>",
"size": 123,
"sourceGroup": "CONTENT",
"type": "<string>",
"url": "<string>",
"width": 123
}
],
"paging": {
"next": {
"after": "<string>",
"link": "<string>"
},
"prev": {
"before": "<string>",
"link": "<string>"
}
}
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
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.
Search files by access. If 'true' will show only public files; if 'false' will show only private files
Search files updated before this timestamp. Time must be epoch time in milliseconds.
Search files by exact time of creation. Time must be epoch time in milliseconds.
Search files by greater than or equal to time of creation. Can be used with createdAtLte to create a range.
Search files by less than or equal to time of creation. Can be used with createdAtGte to create a range.
Search files by specified encoding.
Search files by exact expires time. Time must be epoch time in milliseconds.
Search files by greater than or equal to expires time. Can be used with expiresAtLte to create a range.
Search files by less than or equal to expires time. Can be used with expiresAtGte to create a range.
Search files by given extension.
Search files by specific md5 hash.
Search files by height of image or video.
Search files by greater than or equal to height of image or video. Can be used with heightLte to create a range.
Search files by less than or equal to height of image or video. Can be used with heightGte to create a range.
Search files by greater than or equal to ID. Can be used with idLte to create a range.
Search files by less than or equal to ID. Can be used with idGte to create a range.
If true shows files that have been marked to be used in new content. It false shows files that should not be used in new content.
Number of items to return. Default limit is 10, maximum limit is 100.
Search for files containing the given name.
Search files by path.
Desired file properties in the return object.
Search files by exact file size in bytes.
Search files by greater than or equal to file size. Can be used with sizeLte to create a range.
Search files by less than or equal to file size. Can be used with sizeGte to create a range.
Sort files by a given field.
Search files by file type.
Search files by exact time of latest updated. Time must be epoch time in milliseconds.
Search files by greater than or equal to time of latest update. Can be used with updatedAtLte to create a range.
Search files by less than or equal to time of latest update. Can be used with updatedAtGte to create a range.
Search for given URL
Search files by width of image or video.
Search files by greater than or equal to width of image or video. Can be used with widthLte to create a range.
Search files by less than or equal to width of image or video. Can be used with widthGte to create a range.
Was this page helpful?