メインコンテンツへスキップ
POST
/
crm
/
lists
/
2026-03
/
search
リストを検索
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>"
}
'
import requests

url = "https://api.hubapi.com/crm/lists/2026-03/search"

payload = {
    "additionalProperties": ["<string>"],
    "listIds": ["<string>"],
    "offset": 123,
    "processingTypes": ["<string>"],
    "count": 123,
    "objectTypeId": "<string>",
    "query": "<string>",
    "sort": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    additionalProperties: ['<string>'],
    listIds: ['<string>'],
    offset: 123,
    processingTypes: ['<string>'],
    count: 123,
    objectTypeId: '<string>',
    query: '<string>',
    sort: '<string>'
  })
};

fetch('https://api.hubapi.com/crm/lists/2026-03/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/crm/lists/2026-03/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'additionalProperties' => [
        '<string>'
    ],
    'listIds' => [
        '<string>'
    ],
    'offset' => 123,
    'processingTypes' => [
        '<string>'
    ],
    'count' => 123,
    'objectTypeId' => '<string>',
    'query' => '<string>',
    'sort' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/crm/lists/2026-03/search"

	payload := strings.NewReader("{\n  \"additionalProperties\": [\n    \"<string>\"\n  ],\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"offset\": 123,\n  \"processingTypes\": [\n    \"<string>\"\n  ],\n  \"count\": 123,\n  \"objectTypeId\": \"<string>\",\n  \"query\": \"<string>\",\n  \"sort\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.hubapi.com/crm/lists/2026-03/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"additionalProperties\": [\n    \"<string>\"\n  ],\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"offset\": 123,\n  \"processingTypes\": [\n    \"<string>\"\n  ],\n  \"count\": 123,\n  \"objectTypeId\": \"<string>\",\n  \"query\": \"<string>\",\n  \"sort\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm/lists/2026-03/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"additionalProperties\": [\n    \"<string>\"\n  ],\n  \"listIds\": [\n    \"<string>\"\n  ],\n  \"offset\": 123,\n  \"processingTypes\": [\n    \"<string>\"\n  ],\n  \"count\": 123,\n  \"objectTypeId\": \"<string>\",\n  \"query\": \"<string>\",\n  \"sort\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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
}
{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

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>
必須

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

最終更新日 2026年4月10日