Zum Hauptinhalt springen
POST
/
crm
/
v3
/
lists
/
search
Listen durchsuchen
curl --request POST \
  --url https://api.hubapi.com/crm/v3/lists/search \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --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

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Starter
Diese API erfordert einen der folgenden Bereiche:
crm.lists.read

Authorizations

​
private-app
string
header
required

Body

application/json

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

The request object used for searching through lists.

​
offset
integer
required

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.

​
additionalProperties
string[]
required

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“.

​
listIds
string[]

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.

​
query
string

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.

​
count
integer

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“.

​
processingTypes
string[]

Die „processingTypes“, die zum Filtern der Ergebnisse nach „processingType“ verwendet werden. Sofern Werte angegeben werden, enthält die Antwort nur Ergebnisse mit einem „processingType“ in diesem Array.

Wird kein Wert oder eine leere Liste angegeben, werden die Ergebnisse nicht nach „processingType“ gefiltert.

Gültige „processingTypes“: MANUAL, SNAPSHOT oder DYNAMIC.

​
sort
string

Response

Successful response

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

​
total
integer
required

Die Gesamtzahl der Listen, die den Suchkriterien entsprechen.

​
offset
integer
required

Wert, der in einer zukünftigen Anfrage zur Seitennummerierung in den Suchergebnissen der Liste übergeben werden soll.

​
lists
object[]
required

Die Listen, die den Suchkriterien entsprechen.

​
hasMore
boolean
required

Ob es noch mehr Ergebnisse gibt, die durchgeblättert werden müssen oder nicht.