younifyd
Menu

Get /files/v3/files/search Do Search

Search files

GET/files/v3/files/search

Use it in a workflow

  1. Add a step and choose the HubSpot connector.
  2. Pick the Get /files/v3/files/search Do Search action (under Files).
  3. Fill in the fields below, then reference the result from later steps as {{getFilesV3FilesSearchDoSearch.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.

allowsAnonymousAccessboolean

Search files by access. If 'true' will show only public files; if 'false' will show only private files

beforestring

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

createdAtstring (date-time)

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

createdAtGtestring (date-time)

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

createdAtLtestring (date-time)

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

encodingstring

Search files by specified encoding.

expiresAtstring (date-time)

Search files by exact expires time. Time must be epoch time in milliseconds.

expiresAtGtestring (date-time)

Search files by greater than or equal to expires time. Can be used with expiresAtLte to create a range.

expiresAtLtestring (date-time)

Search files by less than or equal to expires time. Can be used with expiresAtGte to create a range.

extensionstring

Search files by given extension.

fileMd5string

Search files by specific md5 hash.

heightinteger (int32)

Search files by height of image or video.

heightGteinteger (int32)

Search files by greater than or equal to height of image or video. Can be used with heightLte to create a range.

heightLteinteger (int32)

Search files by less than or equal to height of image or video. Can be used with heightGte to create a range.

idGteinteger (int64)

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

idLteinteger (int64)

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

idsarray<integer (int64)>
isUsableInContentboolean

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.

limitinteger (int32)

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

namestring

Search for files containing the given name.

parentFolderIdsarray<integer (int64)>
pathstring

Search files by path.

propertiesarray<string>

Desired file properties in the return object.

sizeinteger (int64)

Search files by exact file size in bytes.

sizeGteinteger (int64)

Search files by greater than or equal to file size. Can be used with sizeLte to create a range.

sizeLteinteger (int64)

Search files by less than or equal to file size. Can be used with sizeGte to create a range.

sortarray<string>

Sort files by a given field.

typestring

Search files by file type.

updatedAtstring (date-time)

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

updatedAtGtestring (date-time)

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

updatedAtLtestring (date-time)

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

urlstring

Search for given URL

widthinteger (int32)

Search files by width of image or video.

widthGteinteger (int32)

Search files by greater than or equal to width of image or video. Can be used with widthLte to create a range.

widthLteinteger (int32)

Search files by less than or equal to width of image or video. Can be used with widthGte to create a range.

Response

Returns 200 with an object. Read it in later steps with {{getFilesV3FilesSearchDoSearch.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>
accessstringrequired

File access. Can be PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, PRIVATE.

One ofHIDDEN_INDEXABLEHIDDEN_NOT_INDEXABLEHIDDEN_PRIVATEHIDDEN_SENSITIVEPRIVATEPUBLIC_INDEXABLEPUBLIC_NOT_INDEXABLESENSITIVE

archivedbooleanrequired

If the file is deleted.

archivedAtstring (date-time)

Deletion time of the file object.

createdAtstring (date-time)required

Creation time of the file object.

defaultHostingUrlstring

Default hosting URL of the file. This will use one of HubSpot's provided URLs to serve the file.

encodingstring

Encoding of the file.

expiresAtinteger (int64)
extensionstring

Extension of the file. ex: .jpg, .png, .gif, .pdf, etc.

fileMd5string

The MD5 hash of the file.

heightinteger (int32)

For image and video files, the height of the content.

idstringrequired

File ID.

isUsableInContentboolean

Previously "archied". Indicates if the file should be used when creating new content like web pages.

namestring

Name of the file.

parentFolderIdstring

ID of the folder the file is in.

pathstring

Path of the file in the file manager.

sizeinteger (int64)

Size of the file in bytes.

sourceGroupstring

One ofCONTENTCONVERSATIONSFORMSUI_EXTENSIONSUNKNOWN

typestring

Type of the file. Can be IMG, DOCUMENT, AUDIO, MOVIE, or OTHER.

updatedAtstring (date-time)required

Timestamp of the latest update to the file.

urlstring

URL of the given file. This URL can change depending on the domain settings of the account. Will use the select file hosting domain.

widthinteger (int32)

For image and video files, the width of the content.

json
{
  "results": [
    {
      "access": "HIDDEN_INDEXABLE",
      "archived": false,
      "createdAt": "2025-01-01T00:00:00Z",
      "id": "string",
      "updatedAt": "2025-01-01T00:00:00Z",
      "archivedAt": "2025-01-01T00:00:00Z",
      "defaultHostingUrl": "string",
      "encoding": "string",
      "expiresAt": 0,
      "extension": "string",
      "fileMd5": "string",
      "height": 0
    }
  ],
  "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.