GET
/
files
/
v3
/
folders
/
search
フォルダーを検索
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"
    }
  ]
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
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[]

指定したプロパティーを基準に結果の表示順を変更します。例えば、-nameでは名前フィールドを基準に降順で表示順を変更し、nameでは名前フィールドを基準に照準で表示順を変更します。

​
ids
integer[]
​
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のフォルダーを検索します。

Response

200
application/json

successful operation

The response is of type object.