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
}Durchsuchen Sie Listen nach Listennamen oder blättern Sie durch alle Listen durch, indem ein leerer „query“-Wert bereitgestellt wird.
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
}Unterstützte Produkte
Erforderliche Bereiche
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.
Die Eigenschaftsnamen aller zusätzlichen Listeneigenschaften, die in die Antwort aufgenommen werden sollen. Eigenschaften, die für eine bestimmte Liste nicht vorhanden oder leer sind, werden nicht in die Antwort aufgenommen.
Standardmäßig werden bei allen Anfragen die folgenden Eigenschaften für jede Liste abgerufen: „hs_list_size“, „hs_last_record_added_at“, „hs_last_record_removed_at“, „hs_folder_name“ und „hs_list_reference_count“.
Wert, der zur Seitennummerierung in Listen verwendet wird. Der in der Antwort bereitgestellte „Versatz“ kann bei der nächsten Anfrage verwendet werden, um die nächste Seite der Ergebnisse abzurufen. Standardwert „0“, wenn kein Versatz angegeben wird.
Die Anzahl der Listen, die in die Antwort enthalten sein sollen. Der Standardwert ist „20“, wenn kein Wert angegeben wird. Die maximale Anzahl ist „500“.
Die „listIds“, die zum Filtern der Ergebnisse nach „listId “ verwendet werden. Sofern Werte angegeben werden, enthält die Antwort nur Ergebnisse mit einer „listId“ in diesem Array.
Wird kein Wert oder eine leere Liste angegeben, werden die Ergebnisse nicht nach „listId“ gefiltert.
Listenverarbeitungstypen, die in den Suchergebnissen enthalten sein sollen. Sofern nicht angegeben, werden alle Listen mit allen Verarbeitungstypen berücksichtigt.
Die „Abfrage“, die für die Suche nach Listen anhand des Listennamens verwendet wird. Wenn keine „Abfrage“ angegeben wird, sind in den Ergebnissen alle Listen enthalten.
Sortierfeld und -reihenfolge
Successful response
The response object with the list search hits and additional information regarding pagination.
Ob es noch mehr Ergebnisse gibt, die durchgeblättert werden müssen oder nicht.
Die Listen, die den Suchkriterien entsprechen.
Show child attributes
Wert, der in einer zukünftigen Anfrage zur Seitennummerierung in den Suchergebnissen der Liste übergeben werden soll.
Die Gesamtzahl der Listen, die den Suchkriterien entsprechen.