Zum Hauptinhalt springen
GET
/
conversations
/
v3
/
conversations
/
threads
Get threads
curl --request GET \
  --url https://api.hubapi.com/conversations/v3/conversations/threads \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    }
  },
  "results": [
    {
      "associatedContactId": "<string>",
      "threadAssociations": {
        "associatedTicketId": "<string>"
      },
      "assignedTo": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "archived": true,
      "originalChannelId": "<string>",
      "latestMessageTimestamp": "2023-11-07T05:31:56Z",
      "latestMessageSentTimestamp": "2023-11-07T05:31:56Z",
      "originalChannelAccountId": "<string>",
      "id": "<string>",
      "closedAt": "2023-11-07T05:31:56Z",
      "spam": true,
      "inboxId": "<string>",
      "status": "OPEN",
      "latestMessageReceivedTimestamp": "2023-11-07T05:31:56Z"
    }
  ]
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit
Cette API requiert l'une des portées suivantes :
conversations.read

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
after
string

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

​
limit
integer

The maximum number of results to display per page.

​
sort
string[]

Set the sort order of the response. Valid options are id (default) and latestMessageTimestamp (which requires the latestMessageTimestampAfter field to also be set). If you’re filtering threads by associatedContactId , you can sort in descending order by prepending - to the sort option (e.g., -id or -latestMessageTimestampAfter ). Otherwise, results are always returned in ascending order.

​
inboxId
integer[]

The ID of the conversations inbox you can optionally include to retrieve the associated messages for. This parameter cannot be used in conjunction with the associatedContactId property.

​
associatedContactId
integer

Retrieve a filtered list of conversations for a specific contact by its ID. This parameter cannot be used in conjunction with the inboxId property.

​
threadStatus
string

The status of the associated conversations to filter by (either OPEN or CLOSED). This property must be provided if you’re including the associatedContactId query parameter.

​
latestMessageTimestampAfter
string<date-time>

The minimum(earliest) latestMessageTimestamp. This is required only when sorting by latestMessageTimestamp.

​
archived
boolean

Whether to return only results that have been archived.

​
association
enum<string>[]

You can specify an association type here of TICKET. If this is set the response will included a thread associations object and associated ticket id if present. If there are no associations to a ticket with this conversation, then the thread associations object will not be present on the response.

​
property
string

A specific property to include in the thread response.

Response

successful operation

​
results
object[]
required
​
paging
object