メインコンテンツへスキップ
POST
/
crm
/
lists
/
2026-03
/
search
cURL
curl --request POST \
  --url https://api.hubapi.com/crm/lists/2026-03/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "additionalProperties": [
    "<string>"
  ],
  "listIds": [
    "<string>"
  ],
  "offset": 123,
  "processingTypes": [
    "<string>"
  ],
  "count": 123,
  "objectTypeId": "<string>",
  "query": "<string>",
  "sort": "<string>"
}
'
{
  "hasMore": true,
  "lists": [
    {
      "additionalProperties": {},
      "listId": "<string>",
      "listVersion": 123,
      "name": "<string>",
      "objectTypeId": "<string>",
      "processingStatus": "<string>",
      "processingType": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdById": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "filtersUpdatedAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedById": "<string>"
    }
  ],
  "offset": 123,
  "total": 123
}

Supported products

承認

Authorization
string
header
必須

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

ボディ

application/json
additionalProperties
string[]
必須

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

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

listIds
string[]
必須

検索結果に含めるILSリストID。指定しない場合、他の条件に一致する全てのリストが含まれます

offset
integer<int32>
必須

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

processingTypes
string[]
必須

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

count
integer<int32>

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

objectTypeId
string
query
string

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

sort
string

順序フィールドと順序

レスポンス

successful operation

hasMore
boolean
必須

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

lists
object[]
必須

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

offset
integer<int32>
必須

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

total
integer<int32>
必須

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

Last modified on April 14, 2026