Zum Hauptinhalt springen
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 -Starter
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -Starter
この API には、次のいずれかのスコープが必要です。
crm.lists.read

Authorizations

Authorization
string
header
required

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

Body

application/json

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

The request object used for searching through lists.

listIds
string[]

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

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

offset
integer

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

query
string

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

count
integer

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

processingTypes
string[]

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

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

有効な「processingTypes」は「MANUAL」、「SNAPSHOT」、または「DYNAMIC」です。

additionalProperties
string[]

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

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

sort
string

Response

Successful response

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

total
integer
required

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

offset
integer
required

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

lists
object[]
required

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

hasMore
boolean
required

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