HubSpot · JSON Structure

Crm Lists Api List Structure

A HubSpot CRM list.

Type: object Properties: 9
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

List is a JSON Structure definition published by HubSpot, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

listId name listType objectTypeId processingStatus createdAt updatedAt filterBranch memberCount

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/crm-lists-api-list-structure.json",
  "name": "List",
  "description": "A HubSpot CRM list.",
  "type": "object",
  "properties": {
    "listId": {
      "type": "string",
      "description": "The unique identifier for the list.",
      "example": "500123"
    },
    "name": {
      "type": "string",
      "description": "The name of the list.",
      "example": "Example Record"
    },
    "listType": {
      "type": "string",
      "enum": [
        "STATIC",
        "DYNAMIC"
      ],
      "description": "Whether the list is static (manually managed) or dynamic (filter-based).",
      "example": "STATIC"
    },
    "objectTypeId": {
      "type": "string",
      "description": "The object type the list contains (e.g., 0-1 for contacts).",
      "example": "500123"
    },
    "processingStatus": {
      "type": "string",
      "description": "The current processing status of the list.",
      "example": "active"
    },
    "createdAt": {
      "type": "datetime",
      "description": "The date and time the list was created.",
      "example": "2025-03-15T14:30:00Z"
    },
    "updatedAt": {
      "type": "datetime",
      "description": "The date and time the list was last updated.",
      "example": "2025-03-15T14:30:00Z"
    },
    "filterBranch": {
      "type": "object",
      "description": "The filter definition for dynamic lists.",
      "example": {}
    },
    "memberCount": {
      "type": "int32",
      "description": "The current number of members in the list.",
      "example": 10
    }
  }
}