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
}リスト名でリストを検索するか、空の「クエリ」値を指定して全てのリストを表示します。
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
}サポートされる製品
必須スコープ
The access token received from the authorization server in the OAuth 2.0 flow.
The IDs of the records to add and/or remove from the list.
The request object used for searching through lists.
レスポンスに含める追加のリストプロパティーのプロパティー名。特定のリストの存在しないプロパティーまたは空のプロパティーはレスポンスに含まれません。
デフォルトでは、全てのリクエストで各リストのプロパティー(「hs_list_size」、hs_last_record_added_at」、「hs_last_record_removed_at」、「hs_folder_name」、「hs_list_reference_count」)が取得されます。
リストのページ送りに使用される値。レスポンスで指定された「オフセット」を次のリクエストで使用して、結果の次のページを取得することができます。オフセットが指定されていない場合、デフォルトの「0」になります。
レスポンスに含めるリストの数。値が指定されていない場合、デフォルトの「20」になります。「最大数」は「500」です。
「listId」で結果を絞り込むために使用される「listIds」。値が指定されている場合、レスポンスにはこの配列に「listId」がある結果しか含まれなくなります。
値が指定されていない場合、または空のリストが指定されている場合、結果は「listId」で絞り込まれません。
検索結果に含めるリスト処理タイプ。指定しない場合、全ての処理タイプの全てのリストが含まれます。
リスト名でリストを検索するために使用される「クエリ」。「クエリ」が指定されていない場合、全てのリストが結果に含まれます。
順序フィールドと順序