Retrieve threads
Récupérez une liste de fils de conversations à partir des boîtes de réception spécifiées dans votre compte HubSpot. Ce point de terminaison vous permet de filtrer les fils par contacts associés, tickets, statut, et plus encore. Utile pour gérer et examiner efficacement les fils de conversations.
Supported products
Supported products
Required Scopes
Required Scopes
Autorisations
The access token received from the authorization server in the OAuth 2.0 flow.
Paramètres de requête
Le jeton de curseur de pagination de la dernière ressource lue avec succès sera renvoyé en tant que propriété JSON « paging.next.after » d'une réponse paginée contenant plus de résultats.
S'il faut renvoyer uniquement les résultats qui ont été archivés.
Récupèrer une liste filtrée des conversations pour un contact spécifique à l'aide de son ID. Ce paramètre ne peut pas être utilisé conjointement avec la propriété « inboxId ».
L'ID d'un ticket associé au fil de discussion. Lorsqu'il est fourni, renvoie uniquement les fils de discussion liés au ticket spécifié.
Vous pouvez préciser ici un type d'association « TICKET ». Si cette option est sélectionnée, la réponse inclura un objet d'associations de fils de discussion et l'ID du ticket associé, s'il existe. S'il n'y a aucune association à un ticket avec cette conversation, l'objet d'associations de fils de discussion ne sera pas présent dans la réponse.
TICKET L'ID de la boîte de réception conversations que vous pouvez inclure facultativement pour récupérer les messages associés. Ce paramètre ne peut pas être utilisé conjointement avec la propriété « associatedContactId ».
La valeur minimale (la plus ancienne) de « latestMessageTimestamp ». Ceci n'est requis que lors du tri par « latestMessageTimestamp »
Le nombre maximum de résultats à afficher par page.
Une propriété spécifique à inclure dans la réponse du fil de discussion.
Définissez l'ordre de tri des réponses. Les options valides sont « id » (par défaut) et « latestMessageTimestamp » (qui nécessite également la définition du champ « latestMessageTimestampAfter »). Si vous filtrez les fils de discussion par « associatedContactId » , vous pouvez trier par ordre décroissant en ajoutant un - devant l'option de tri (par exemple, « -id » ou « -latestMessageTimestampAfter »). Sinon, les résultats sont toujours renvoyés par ordre croissant.
Statut des conversations associées à filtrer (« OUVERT » ou « FERMÉ »). Cette propriété doit être fournie si vous incluez le paramètre de requête « associatedContactId ».
CLOSED, OPEN