Passer au contenu principal
POST
/
crm
/
v3
/
lists
/
search
cURL
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
}

Documentation Index

Fetch the complete documentation index at: https://developers.hubspot.fr/docs/llms.txt

Use this file to discover all available pages before exploring further.

Supported products

Autorisations

Authorization
string
header
requis

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

Corps

application/json

The request object used for searching through lists.

additionalProperties
string[]
requis

Les noms des propriétés de liste supplémentaires à inclure dans la réponse. Les propriétés qui n'existent pas ou qui sont vides pour une liste particulière ne sont pas incluses dans la réponse.

Par défaut, toutes les demandes récupéreront les propriétés suivantes pour chaque liste : « hs_last_record_added_at » « hs_last_record_removed_at » « hs_folder_name » « hs_list_reference_count ».

offset
integer<int32>
requis

Valeur utilisée pour paginer les listes. Le « décalage » fourni dans la réponse peut être utilisé dans la prochaine requête pour récupérer la page suivante des résultats. Par défaut, la valeur est « 0 » si aucun décalage n'est fourni.

count
integer<int32>

Le nombre de listes à inclure dans la réponse. Par défaut, « 20 » si aucune valeur n'est fournie. Le « nombre » maximum est « 500 ».

listIds
string[]

ID des listes ILS à inclure dans les résultats de recherche. Si rien n'est spécifié, toutes les listes correspondant aux autres critères seront incluses

objectTypeId
string
processingTypes
string[]

Liste des types de traitement à inclure dans les résultats de recherche. Si rien n'est spécifié, toutes les listes avec tous les types de traitement seront incluses.

query
string

La « requête » qui sera utilisée pour rechercher des listes par nom de liste. Si aucune « requête » n'est fournie, les résultats incluront toutes les listes.

sort
string

Trier le champ et l'ordre

Réponse

successful operation

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

hasMore
boolean
requis

S'il y a plus de résultats à parcourir ou non.

lists
object[]
requis

Les listes qui correspondent aux critères de recherche.

offset
integer<int32>
requis

Valeur à transmettre dans une future requête pour paginer les résultats de recherche de la liste.

total
integer<int32>
requis

Le nombre total de listes correspondant aux critères de recherche.

Last modified on May 13, 2026