HubSpot · Schema

ThreadCollection

Paginated collection of conversation threads

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
results array Array of thread records
paging object Pagination information for list responses.
View JSON Schema on GitHub

JSON Schema

hubspot-conversations-thread-collection-schema.json Raw ↑
{
  "type": "object",
  "description": "Paginated collection of conversation threads",
  "properties": {
    "results": {
      "type": "array",
      "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
        }
      ],
      "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",
            "description": "Current status of the thread",
            "example": "OPEN",
            "enum": [
              "OPEN",
              "CLOSED"
            ]
          },
          "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": "string",
            "description": "ISO 8601 timestamp of the latest message",
            "format": "date-time",
            "example": "2024-01-20T10:30:00Z"
          },
          "latestMessageSentTimestamp": {
            "type": "string",
            "description": "ISO 8601 timestamp of the latest sent message",
            "format": "date-time",
            "example": "2024-01-20T10:25:00Z"
          },
          "latestMessageReceivedTimestamp": {
            "type": "string",
            "description": "ISO 8601 timestamp of the latest received message",
            "format": "date-time",
            "example": "2024-01-20T10:30:00Z"
          },
          "closedAt": {
            "type": "string",
            "description": "ISO 8601 timestamp when the thread was closed",
            "format": "date-time",
            "example": "2024-01-21T15:00:00Z"
          },
          "createdAt": {
            "type": "string",
            "description": "ISO 8601 timestamp when the thread was created",
            "format": "date-time",
            "example": "2024-01-15T09:00:00Z"
          },
          "archived": {
            "type": "boolean",
            "description": "Whether the thread is archived",
            "example": false
          }
        },
        "required": [
          "id",
          "inboxId",
          "status",
          "createdAt"
        ]
      }
    },
    "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"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ThreadCollection"
}