Pular para o conteúdo principal
GET
/
crm
/
v3
/
lists
/
{listId}
Buscar lista por ID
curl --request GET \
  --url https://api.hubapi.com/crm/v3/lists/{listId} \
  --header 'Authorization: Bearer <token>'
{
  "list": {
    "createdAt": "2023-11-15T18:15:00.812Z",
    "createdById": "123",
    "filterBranch": {
      "filterBranchOperator": "OR",
      "filterBranchType": "OR",
      "filterBranches": [
        {
          "filterBranchOperator": "AND",
          "filterBranchType": "AND",
          "filters": [
            {
              "filterType": "PROPERTY",
              "operation": {
                "includeObjectsWithNoValueSet": false,
                "operationType": "ENUMERATION",
                "operator": "IS_ANY_OF",
                "values": [
                  "inactive",
                  "active"
                ]
              },
              "property": "hs_content_membership_status"
            },
            {
              "filterType": "IN_LIST",
              "listId": 2,
              "operator": "IN_LIST"
            }
          ]
        }
      ]
    },
    "filtersUpdatedAt": "2023-11-15T18:15:00.812Z",
    "listId": "1",
    "listVersion": 1,
    "name": "Snapshot List Example",
    "objectTypeId": "0-1",
    "processingStatus": "COMPLETE",
    "processingType": "SNAPSHOT",
    "size": 330,
    "updatedAt": "2023-11-15T18:15:20.210Z",
    "updatedById": "123"
  }
}

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 caminho

listId
string
obrigatório

O ID ILS da lista a ser buscada.

Parâmetros de consulta

includeFilters
boolean
padrão:false

Um sinalizador indicando se a definição da lista de objetos de resposta deve ou não incluir uma definição de ramificação de filtro. Por padrão, as definições de lista de objetos não terão suas definições de ramificação de filtro incluídas na resposta.

Resposta

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

The response for a list fetch request.

list
object
obrigatório

An object list definition.

Last modified on March 24, 2026