HubSpot · Schema

ChannelCollection

Paginated collection of channels

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

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

JSON Schema

hubspot-conversations-channel-collection-schema.json Raw ↑
{
  "type": "object",
  "description": "Paginated collection of channels",
  "properties": {
    "results": {
      "type": "array",
      "description": "Array of channel records",
      "example": [
        {
          "id": "channel_789",
          "name": "Website Chat",
          "type": "CHAT",
          "accountId": "account_123",
          "createdAt": "2024-01-01T00:00:00Z"
        }
      ],
      "items": {
        "type": "object",
        "description": "Represents a communication channel for conversations.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the channel",
            "example": "channel_789"
          },
          "name": {
            "type": "string",
            "description": "Display name of the channel",
            "example": "Website Chat"
          },
          "type": {
            "type": "string",
            "description": "Type of channel (e.g., EMAIL, CHAT, FACEBOOK)",
            "example": "CHAT"
          },
          "accountId": {
            "type": "string",
            "description": "Associated account ID",
            "example": "account_123"
          },
          "createdAt": {
            "type": "string",
            "description": "ISO 8601 timestamp when the channel was created",
            "format": "date-time",
            "example": "2024-01-01T00:00:00Z"
          }
        },
        "required": [
          "id",
          "name",
          "type"
        ]
      }
    },
    "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": "ChannelCollection"
}