HubSpot · Schema

List

A HubSpot CRM list.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name	Type	Description
listId	string	The unique identifier for the list.
name	string	The name of the list.
listType	string	Whether the list is static (manually managed) or dynamic (filter-based).
objectTypeId	string	The object type the list contains (e.g., 0-1 for contacts).
processingStatus	string	The current processing status of the list.
createdAt	string	The date and time the list was created.
updatedAt	string	The date and time the list was last updated.
filterBranch	object	The filter definition for dynamic lists.
memberCount	integer	The current number of members in the list.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/crm-lists-api-list-schema.json",
  "title": "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": "string",
      "format": "date-time",
      "description": "The date and time the list was created.",
      "example": "2025-03-15T14:30:00Z"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "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": "integer",
      "description": "The current number of members in the list.",
      "example": 10
    }
  }
}