GET
/
files
/
v3
/
files
/
search
ファイルを検索
curl --request GET \
  --url https://api.hubapi.com/files/v3/files/search \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    },
    "prev": {
      "before": "",
      "link": ""
    }
  },
  "results": [
    {
      "extension": "<string>",
      "access": "PUBLIC_INDEXABLE",
      "parentFolderId": "<string>",
      "sourceGroup": "<string>",
      "fileMd5": "<string>",
      "encoding": "<string>",
      "type": "<string>",
      "isUsableInContent": true,
      "url": "<string>",
      "expiresAt": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "archivedAt": "2023-11-07T05:31:56Z",
      "path": "<string>",
      "archived": true,
      "size": 123,
      "name": "<string>",
      "width": 123,
      "id": "<string>",
      "defaultHostingUrl": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "height": 123
    }
  ]
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub無料ツール
Sales HubSales Hub無料ツール
Service HubService Hub無料ツール
Content HubContent HubStarter

必須スコープ

この API には、次のいずれかのスコープが必要です。
  • 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[]

返されるファイルプロパティーのリスト。

after
string

この値だけ検索結果をオフセットします。デフォルトのオフセットは0で、それぞれの検索の項目の最大オフセットは10,000です。この上限に達する場合は検索を絞り込んでください。

before
string
limit
integer

返す項目の数。デフォルトの上限は10個で、最大の上限は100個です。

sort
string[]

指定したフィールドを基準にファイルの表示順を変更します。

ids
integer[]

ファイルIDのリストで検索します。

idLte
integer
idGte
integer
createdAt
string<date-time>

作成時刻のファイルを検索します。

createdAtLte
string<date-time>

作成時刻以下のファイルを検索します。createdAtGteと一緒に使用して範囲を作成できます。

createdAtGte
string<date-time>

作成時刻以上のファイルを検索します。createdAtLteと一緒に使用して範囲を作成できます。

updatedAt
string<date-time>

最終更新の時刻のファイルを検索します。

updatedAtLte
string<date-time>

最終更新の時刻以下のファイルを検索します。updatedAtGteと一緒に使用して範囲を作成できます。

updatedAtGte
string<date-time>

最終更新の時刻以上のファイルを検索します。updatedAtLteと一緒に使用して範囲を作成できます。

name
string

指定した名前が含まれるファイルを検索します。

path
string

パスでファイルを検索します。

parentFolderIds
integer[]

指定されたfolderId内のファイルを検索します。

size
integer

特定のファイルサイズ(バイト単位)のファイルを検索します。

sizeLte
integer

ファイルサイズ以下のファイルを検索します。sizeGteと一緒に使用して範囲を作成できます。

sizeGte
integer

ファイルサイズ以上のファイルを検索します。sizeLteと一緒に使用して範囲を作成できます。

height
integer

画像または動画の高さでファイルを検索します。

heightLte
integer

画像または動画の高さ以下のファイルを検索します。heightGteと一緒に使用して範囲を作成できます。

heightGte
integer

画像または動画の高さ以上のファイルを検索します。heightLteと一緒に使用して範囲を作成できます。

width
integer

画像または動画の幅でファイルを検索します。

widthLte
integer

画像または動画の幅以下のファイルを検索します。widthGteと一緒に使用して範囲を作成できます。

widthGte
integer

画像または動画の幅以上のファイルを検索します。widthLteと一緒に使用して範囲を作成できます。

encoding
string

指定したエンコーディングでファイルを検索します。

type
string

指定したファイルタイプで絞り込みます。

extension
string

指定した拡張子でファイルを検索します。

url
string

ファイルのURLで検索します。

isUsableInContent
boolean

trueの場合、新しいコンテンツ内で使用することを示されたファイルを表示します。falseの場合、新しいコンテンツ内で使用しないファイルを表示します。

allowsAnonymousAccess
boolean

アクセス権に基づいてファイルを検索します。trueの場合、公開ファイルのみが表示されます。false'の場合、非公開ファイルのみが表示されます。

fileMd5
string

特定のmd5ハッシュのファイルを検索します。

expiresAt
string<date-time>

特定の有効期限のファイルを検索します。時刻はエポック時間(ミリ秒単位)にする必要があります。

expiresAtLte
string<date-time>

有効期限以下の時間のファイルを検索します。expiresAtGteと一緒に使用して範囲を作成できます。

expiresAtGte
string<date-time>

有効期限以上のファイルを検索します。expiresAtLteと一緒に使用して範囲を作成できます。

Response

200
application/json

successful operation

Collections of files