curl --request POST \
--url https://api.hubapi.com/crm/v3/lists/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"additionalProperties": [
"hs_list_size_week_delta"
],
"count": 100,
"offset": 0,
"query": "Test"
}
'{
"hasMore": false,
"lists": [
{
"additionalProperties": {
"hs_last_record_added_at": "1695938616824",
"hs_list_reference_count": "0",
"hs_list_size": "59",
"hs_list_size_week_delta": "-10"
},
"createdAt": "2023-09-28T22:03:17.998Z",
"createdById": "1",
"filtersUpdatedAt": "2023-09-28T22:03:17.998Z",
"listId": "123",
"listVersion": 1,
"name": "Test list",
"objectTypeId": "0-1",
"processingStatus": "COMPLETE",
"processingType": "SNAPSHOT",
"updatedAt": "2023-09-28T22:03:37.005Z",
"updatedById": "1"
}
],
"offset": 1,
"total": 1
}Busca listas por nombre de lista o busca en todas las listas proporcionando un valor de “consulta” vacío.
curl --request POST \
--url https://api.hubapi.com/crm/v3/lists/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"additionalProperties": [
"hs_list_size_week_delta"
],
"count": 100,
"offset": 0,
"query": "Test"
}
'{
"hasMore": false,
"lists": [
{
"additionalProperties": {
"hs_last_record_added_at": "1695938616824",
"hs_list_reference_count": "0",
"hs_list_size": "59",
"hs_list_size_week_delta": "-10"
},
"createdAt": "2023-09-28T22:03:17.998Z",
"createdById": "1",
"filtersUpdatedAt": "2023-09-28T22:03:17.998Z",
"listId": "123",
"listVersion": 1,
"name": "Test list",
"objectTypeId": "0-1",
"processingStatus": "COMPLETE",
"processingType": "SNAPSHOT",
"updatedAt": "2023-09-28T22:03:37.005Z",
"updatedById": "1"
}
],
"offset": 1,
"total": 1
}Productos compatibles
Ámbitos Requeridos
The access token received from the authorization server in the OAuth 2.0 flow.
The IDs of the records to add and/or remove from the list.
The request object used for searching through lists.
Los nombres de las propiedades de lista adicionales que se incluirán en la respuesta. Las propiedades que no existen o que están vacías para una lista en particular no se incluyen en la respuesta.
Por opción predeterminada, todas las solicitudes recuperarán las siguientes propiedades para cada lista: hs_list_size, hs_last_record_added_at, hs_last_record_removed_at, hs_folder_name y hs_list_reference_count.
Valor utilizado para paginar las listas. El valor de "desplazamiento" proporcionado en la respuesta se puede usar en la siguiente solicitud para recuperar la siguiente página de resultados. Por opción predeterminada, se establece en "0" si no se proporciona ningún desplazamiento.
El número de listas que se incluirán en la respuesta. Por opción predeterminada, se establece en "20" si no se proporciona ningún valor. El "conteo" máximo es "500".
Los "listIds" que se utilizarán para filtrar los resultados por listId. Si se proporcionan valores, la respuesta solo incluirá resultados que tengan un "listId" en esta secuencia.
Si no se proporciona ningún valor, o si se proporciona una lista vacía, entonces los resultados no se filtrarán por "listId".
Tipos de procesamiento de listas que se incluirán en los resultados de búsqueda. Si no se especifica, se incluirán todas las listas con todos los tipos de procesamiento.
La "consulta" que se utilizará para buscar listas por nombre de lista. Si no se proporciona ninguna "consulta", los resultados incluirán todas las listas.
Ordenar campo y orden
Successful response
The response object with the list search hits and additional information regarding pagination.
Si hay o no hay más resultados para paginar.
Las listas que coincidieron con los criterios de búsqueda.
Show child attributes
Valor que se pasará en una futura solicitud para paginar los resultados de la búsqueda de listas.
El número total de listas que coinciden con los criterios de búsqueda.