POST
/
crm
/
v3
/
lists
/
search
Search Lists
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
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubStarter
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubStarter

​
Required Scopes

This API requires one of the following scopes:
  • crm.lists.read

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The IDs of the records to add and/or remove from the list.

The request object used for searching through lists.

Response

200
application/json

Successful response

The response object with the list search hits and additional information regarding pagination.