Retrieve threads
HubSpotアカウントの指定された受信トレイからコミュニケーションスレッドのリストを取得します。このエンドポイントでは、関連するコンタクト、チケット、ステータスなどでスレッドを絞り込むことができます。コミュニケーションスレッドを効率的に管理および確認するのに役立ちます。
Supported products
Supported products
Required Scopes
Required Scopes
承認
The access token received from the authorization server in the OAuth 2.0 flow.
クエリパラメータ
最後に正常に読み取られたリソースのページ操作カーソルトークンは、より多くの結果を含むページ付きレスポンスのpaging.next.after JSONプロパティーとして返されます。
アーカイブ済みの結果のみを返すかどうか。
IDを基準に特定のコンタクトのコミュニケーションの絞り込みリストを取得します。このパラメーターは「inboxId」プロパティーと一緒に使用できません。
スレッドに関連付けられたチケットのID。指定すると、指定されたチケットにリンクされているスレッドのみを返します。
ここで「TICKET」の関連付けタイプを指定できます。これが設定されている場合、レスポンスにはスレッド関連付けオブジェクトと関連付けられているチケットIDが含まれます(ある場合)。このコミュニケーションでチケットへの関連付けがない場合は、スレッド関連付けオブジェクトはレスポンスに存在しなくなります。
TICKET 関連付けられているメッセージを取得するために必要に応じて含めることができるコミュニケーションの受信トレイのID。このパラメーターは「associatedContactId」プロパティーと一緒に使用できません。
最小の(最も早い)「latestMessageTimestamp」。これは、「latestMessageTimestamp」で並べ替える場合のみ必要です。
ページごとに表示する結果の最大数。
スレッドのレスポンスに含める特定のプロパティー。
レスポンスの表示順を設定します。有効なオプションは「id」(デフォルト)と「latestMessageTimestamp」(「latestMessageTimestampAfter」フィールドも設定する必要があります)です。「associatedContactId」でスレッドを絞り込んでいる場合は、並べ替えオプションの先頭に-を付けることで降順で並べ替えることができます(例:「-id」や「-latestMessageTimestampAfter」)。それ以外の場合は、結果は常に昇順で返されます。
絞り込みの基準にするための関連付けられているコミュニケーションのステータス(「OPEN」または「CLOSED」)。このプロパティーは、「associatedContactId」クエリーパラメーターを含めている場合のみ指定する必要があります。
CLOSED, OPEN