Skip to main content
POST
Rechercher des listes

Supported products

Autorisations

Authorization
string
header
requis

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

Corps

application/json
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 ».

listIds
string[]
requis

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

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.

processingTypes
string[]
requis

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.

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

objectTypeId
string
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

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.

Dernière modification le 6 octobre 2026