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
}Pesquise listas pelo nome ou navegue por todas as listas fornecendo um valor vazio para “query”.
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
}Produtos suportados
Escopos Necessários
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.
Os nomes das propriedades de qualquer propriedade de lista adicional a ser incluída na resposta. Propriedades que não existem ou que estão vazias para uma lista específica não são incluídas na resposta.
Por padrão, todas as solicitações buscarão as seguintes propriedades para cada lista: "hs_list_size", "hs_last_record_added_at", "hs_last_record_removed_at", "hs_folder_name" e "hs_list_reference_count".
Valor usado para paginar listas. O "offset" fornecido na resposta pode ser usado na próxima solicitação para buscar a próxima página de resultados. O padrão é "0" se nenhum ajuste for fornecido.
O número de listas a serem incluídas na resposta. O padrão é "20" se nenhum valor for fornecido. O valor máximo de "count" é "500".
Os "listIds" que serão usados para filtrar os resultados por "listId". Se valores forem fornecidos, a resposta incluirá apenas resultados que possuem um "listId" nesta matriz.
Se nenhum valor for fornecido ou se uma lista vazia for fornecida, os resultados não serão filtrados por "listId".
Liste os tipos de processamento a serem incluídos nos resultados da pesquisa. Se não for especificado, todas as listas com todos os tipos de processamento serão incluídas.
A "query" que será usada para procurar listas pelo nome da lista. Se nenhuma "query" for fornecida, os resultados incluirão todas as listas.
Classificar campo e ordem
Successful response
The response object with the list search hits and additional information regarding pagination.
Se há ou não mais resultados para navegar.
As listas que corresponderam aos critérios de pesquisa.
Show child attributes
Valor a ser transmitido em uma solicitação futura para paginar os resultados da pesquisa de lista.
O número total de listas que correspondem aos critérios de pesquisa.