Pular para o conteúdo principal
GET
/
crm
/
v3
/
lists
Fetch Multiple Lists
curl --request GET \
  --url https://api.hubapi.com/crm/v3/lists/ \
  --header 'Authorization: Bearer <token>'
{
  "lists": [
    {
      "createdAt": "2023-11-06T20:44:49.324Z",
      "createdById": "123",
      "filterBranch": {
        "filterBranchOperator": "OR",
        "filterBranchType": "OR",
        "filterBranches": [
          {
            "filterBranchOperator": "AND",
            "filterBranchType": "AND",
            "filters": [
              {
                "filterType": "PROPERTY",
                "operation": {
                  "includeObjectsWithNoValueSet": false,
                  "operationType": "MULTISTRING",
                  "operator": "CONTAINS",
                  "values": [
                    "j"
                  ]
                },
                "property": "firstname"
              }
            ]
          }
        ]
      },
      "filtersUpdatedAt": "2023-11-15T20:24:22.020Z",
      "listId": "1",
      "listVersion": 2,
      "name": "Example List 1",
      "objectTypeId": "0-1",
      "processingStatus": "COMPLETE",
      "processingType": "DYNAMIC",
      "size": 330,
      "updatedAt": "2023-11-15T20:24:36.761Z",
      "updatedById": "123"
    },
    {
      "createdAt": "2023-06-13T14:54:21.852Z",
      "createdById": "123",
      "filterBranch": {
        "filterBranchOperator": "OR",
        "filterBranchType": "OR",
        "filterBranches": [
          {
            "filterBranchOperator": "AND",
            "filterBranchType": "AND",
            "filters": [
              {
                "filterType": "PROPERTY",
                "operation": {
                  "includeObjectsWithNoValueSet": false,
                  "operationType": "MULTISTRING",
                  "operator": "IS_EQUAL_TO",
                  "values": [
                    "Fred"
                  ]
                },
                "property": "firstname"
              }
            ]
          }
        ]
      },
      "filtersUpdatedAt": "2023-06-13T14:54:21.852Z",
      "listId": "2",
      "listVersion": 2,
      "name": "Example List 2",
      "objectTypeId": "0-1",
      "processingStatus": "COMPLETE",
      "processingType": "DYNAMIC",
      "size": 220,
      "updatedAt": "2023-06-13T14:54:53.996Z",
      "updatedById": "123"
    },
    {
      "createdAt": "2023-08-02T16:11:29.182Z",
      "filterBranch": {
        "filterBranchOperator": "OR",
        "filterBranchType": "OR",
        "filterBranches": [
          {
            "associationCategory": "HUBSPOT_DEFINED",
            "associationTypeId": 2,
            "filterBranchOperator": "AND",
            "filterBranchType": "ASSOCIATION",
            "filters": [
              {
                "appId": "123",
                "emailId": "123",
                "filterType": "EMAIL_EVENT",
                "level": "EMAIL_API_CAMPAIGN_GROUP",
                "operator": "LINK_CLICKED"
              }
            ],
            "objectTypeId": "0-1",
            "operator": "IN_LIST"
          }
        ]
      },
      "filtersUpdatedAt": "2023-08-02T16:11:29.182Z",
      "listId": "3",
      "listVersion": 1,
      "name": "Example List 3",
      "objectTypeId": "0-2",
      "processingStatus": "COMPLETE",
      "processingType": "DYNAMIC",
      "size": 100,
      "updatedAt": "2023-08-02T16:13:18.777Z"
    },
    {
      "createdAt": "2023-08-28T18:43:50.703Z",
      "createdById": "123",
      "filterBranch": {
        "filterBranchOperator": "OR",
        "filterBranchType": "OR",
        "filterBranches": [
          {
            "filterBranchOperator": "AND",
            "filterBranchType": "AND",
            "filters": [
              {
                "filterType": "PROPERTY",
                "operation": {
                  "includeObjectsWithNoValueSet": false,
                  "operationType": "MULTISTRING",
                  "operator": "IS_EQUAL_TO",
                  "values": [
                    "red"
                  ]
                },
                "property": "vehicle_color"
              }
            ]
          }
        ]
      },
      "filtersUpdatedAt": "2023-08-28T18:43:50.703Z",
      "listId": "4",
      "listVersion": 1,
      "name": "Example List 4",
      "objectTypeId": "2-14190808",
      "processingStatus": "COMPLETE",
      "processingType": "DYNAMIC",
      "size": 0,
      "updatedAt": "2023-08-28T18:43:56.004Z",
      "updatedById": "123"
    },
    {
      "createdAt": "2023-08-22T19:41:53.210Z",
      "createdById": "858789758",
      "filterBranch": {
        "filterBranchOperator": "OR",
        "filterBranchType": "OR",
        "filterBranches": [
          {
            "associationCategory": "HUBSPOT_DEFINED",
            "associationTypeId": 449,
            "filterBranchOperator": "AND",
            "filterBranchType": "ASSOCIATION",
            "filters": [
              {
                "appId": "123",
                "emailId": "123",
                "filterType": "EMAIL_EVENT",
                "level": "EMAIL_API_CAMPAIGN_GROUP",
                "operator": "RECEIVED"
              }
            ],
            "objectTypeId": "0-1",
            "operator": "IN_LIST"
          }
        ]
      },
      "filtersUpdatedAt": "2023-08-23T18:11:55.326Z",
      "listId": "5",
      "listVersion": 7,
      "name": "Example List 5",
      "objectTypeId": "0-1",
      "processingStatus": "COMPLETE",
      "processingType": "DYNAMIC",
      "size": 5,
      "updatedAt": "2023-08-23T18:14:06.886Z",
      "updatedById": "858789758"
    }
  ]
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de consulta

includeFilters
boolean
padrão:false

A flag indicating whether or not the response object list definitions should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response.

listIds
string[]

The ILS IDs of the lists to fetch.

Resposta

Successful response, for a request with includeFilters set to true.

The response object containing the lists found for a multi-list fetch.

lists
object[]
obrigatório

The object list definitions.

Last modified on December 16, 2025