HubSpot · JSON Structure

Conversations Api Thread Collection Structure

Paginated collection of conversation threads

Type: object Properties: 2 Required: 1

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

ThreadCollection is a JSON Structure definition published by HubSpot, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

results paging

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/conversations-api-thread-collection-structure.json",
  "name": "ThreadCollection",
  "description": "Paginated collection of conversation threads",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Represents a conversation thread containing messages between participants.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the thread",
            "example": "987654321"
          },
          "inboxId": {
            "type": "string",
            "description": "ID of the inbox containing this thread",
            "example": "12345678"
          },
          "status": {
            "type": "string",
            "enum": [
              "OPEN",
              "CLOSED"
            ],
            "description": "Current status of the thread",
            "example": "OPEN"
          },
          "spam": {
            "type": "boolean",
            "description": "Whether the thread is marked as spam",
            "example": false
          },
          "associatedContactId": {
            "type": "string",
            "description": "ID of the associated CRM contact",
            "example": "101"
          },
          "assignedTo": {
            "type": "string",
            "description": "User ID the thread is assigned to",
            "example": "user_456"
          },
          "originalChannelId": {
            "type": "string",
            "description": "ID of the original communication channel",
            "example": "channel_789"
          },
          "originalChannelAccountId": {
            "type": "string",
            "description": "ID of the original channel account",
            "example": "account_123"
          },
          "latestMessageTimestamp": {
            "type": "datetime",
            "description": "ISO 8601 timestamp of the latest message",
            "example": "2024-01-20T10:30:00Z"
          },
          "latestMessageSentTimestamp": {
            "type": "datetime",
            "description": "ISO 8601 timestamp of the latest sent message",
            "example": "2024-01-20T10:25:00Z"
          },
          "latestMessageReceivedTimestamp": {
            "type": "datetime",
            "description": "ISO 8601 timestamp of the latest received message",
            "example": "2024-01-20T10:30:00Z"
          },
          "closedAt": {
            "type": "datetime",
            "description": "ISO 8601 timestamp when the thread was closed",
            "example": "2024-01-21T15:00:00Z"
          },
          "createdAt": {
            "type": "datetime",
            "description": "ISO 8601 timestamp when the thread was created",
            "example": "2024-01-15T09:00:00Z"
          },
          "archived": {
            "type": "boolean",
            "description": "Whether the thread is archived",
            "example": false
          }
        },
        "required": [
          "id",
          "inboxId",
          "status",
          "createdAt"
        ]
      },
      "description": "Array of thread records",
      "example": [
        {
          "id": "987654321",
          "inboxId": "12345678",
          "status": "OPEN",
          "spam": false,
          "associatedContactId": "101",
          "assignedTo": "user_456",
          "originalChannelId": "channel_789",
          "originalChannelAccountId": "account_123",
          "latestMessageTimestamp": "2024-01-20T10:30:00Z",
          "latestMessageSentTimestamp": "2024-01-20T10:25:00Z",
          "latestMessageReceivedTimestamp": "2024-01-20T10:30:00Z",
          "closedAt": "2024-01-21T15:00:00Z",
          "createdAt": "2024-01-15T09:00:00Z",
          "archived": false
        }
      ]
    },
    "paging": {
      "type": "object",
      "description": "Pagination information for list responses.",
      "properties": {
        "next": {
          "type": "object",
          "description": "Pagination cursor information for retrieving the next page.",
          "properties": {
            "after": {
              "type": "string",
              "description": "Cursor token for the next page",
              "example": "NTI1Cg%3D%3D"
            },
            "link": {
              "type": "string",
              "description": "API link to the next page",
              "example": "/conversations/v3/conversations/inboxes?after=NTI1Cg%3D%3D"
            }
          }
        }
      }
    }
  },
  "required": [
    "results"
  ]
}