メインコンテンツへスキップ
POST
/
crm
/
v3
/
lists
/
search
リストを検索
curl --request POST \
  --url https://api.hubapi.com/crm/v3/lists/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "additionalProperties": [
    "hs_list_size_week_delta"
  ],
  "count": 100,
  "offset": 0,
  "query": "Test"
}
'
{
  "hasMore": false,
  "lists": [
    {
      "additionalProperties": {
        "hs_last_record_added_at": "1695938616824",
        "hs_list_reference_count": "0",
        "hs_list_size": "59",
        "hs_list_size_week_delta": "-10"
      },
      "createdAt": "2023-09-28T22:03:17.998Z",
      "createdById": "1",
      "filtersUpdatedAt": "2023-09-28T22:03:17.998Z",
      "listId": "123",
      "listVersion": 1,
      "name": "Test list",
      "objectTypeId": "0-1",
      "processingStatus": "COMPLETE",
      "processingType": "SNAPSHOT",
      "updatedAt": "2023-09-28T22:03:37.005Z",
      "updatedById": "1"
    }
  ],
  "offset": 1,
  "total": 1
}

サポートされる製品

次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

ボディ

application/json

The IDs of the records to add and/or remove from the list.

The request object used for searching through lists.

additionalProperties
string[]
必須

レスポンスに含める追加のリストプロパティーのプロパティー名。特定のリストの存在しないプロパティーまたは空のプロパティーはレスポンスに含まれません。

デフォルトでは、全てのリクエストで各リストのプロパティー(「hs_list_size」、hs_last_record_added_at」、「hs_last_record_removed_at」、「hs_folder_name」、「hs_list_reference_count」)が取得されます。

offset
integer<int32>
必須

リストのページ送りに使用される値。レスポンスで指定された「オフセット」を次のリクエストで使用して、結果の次のページを取得することができます。オフセットが指定されていない場合、デフォルトの「0」になります。

count
integer<int32>

レスポンスに含めるリストの数。値が指定されていない場合、デフォルトの「20」になります。「最大数」は「500」です。

listIds
string[]

「listId」で結果を絞り込むために使用される「listIds」。値が指定されている場合、レスポンスにはこの配列に「listId」がある結果しか含まれなくなります。

値が指定されていない場合、または空のリストが指定されている場合、結果は「listId」で絞り込まれません。

objectTypeId
string
processingTypes
string[]

検索結果に含めるリスト処理タイプ。指定しない場合、全ての処理タイプの全てのリストが含まれます。

query
string

リスト名でリストを検索するために使用される「クエリ」。「クエリ」が指定されていない場合、全てのリストが結果に含まれます。

sort
string

順序フィールドと順序

レスポンス

Successful response

The response object with the list search hits and additional information regarding pagination.

hasMore
boolean
必須

表示する結果が他にあるかどうか。

lists
object[]
必須

検索条件に一致したリスト。

offset
integer<int32>
必須

リスト検索結果のページ送りのために今後のリクエストで渡される値。

total
integer<int32>
必須

検索条件に一致したリストの合計数。

Last modified on March 30, 2026