Skip to main content
GET
/
crm
/
v3
/
lists
/
{listId}
Recuperar lista por ID
curl --request GET \
  --url https://api.hubapi.com/crm/v3/lists/{listId} \
  --header 'private-app: <api-key>'
{
  "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"
  }
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Starter
Esta API requiere uno de los siguientes ámbitos:
crm.lists.read

Authorizations

private-app
string
header
required

Path Parameters

listId
string
required

El ID de ILS de la lista que se recuperará.

Query Parameters

includeFilters
boolean
default:false

Un marcador que indica si la definición de la lista de objetos de la respuesta debe incluir o no una definición de ramificación de filtro. Por opción predeterminada, las definiciones de ramificaciones de filtro de las definiciones de la lista de objetos no se incluirán en la respuesta.

Response

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

The response for a list fetch request.

list
object
required

An object list definition.