Post /crm/v3/lists/search /crm/v3/lists/search

Search Lists

POST/crm/v3/lists/search

Use it in a workflow

Add a step and choose the HubSpot connector.
Pick the Post /crm/v3/lists/search /crm/v3/lists/search action (under Lists).
Fill in the fields below, then reference the result from later steps as {{postCrmV3ListsSearchCrmV3ListsSearch.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

additionalPropertiesarray<string>required

The property names of any additional list properties to include in the response. Properties that do not exist or that are empty for a particular list are not included in the response. By default, all requests will fetch the following properties for each list: `hs_list_size`, `hs_last_record_added_at`, `hs_last_record_removed_at`, `hs_folder_name`, and `hs_list_reference_count`.

countinteger (int32)

The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500`.

listIdsarray<string>

ILS list ids to be included in search results. If not specified, all lists matching other criteria will be included

objectTypeIdstring

offsetinteger (int32)required

Value used to paginate through lists. The `offset` provided in the response can be used in the next request to fetch the next page of results. Defaults to `0` if no offset is provided.

processingTypesarray<string>

List processing types to be included in search results. If not specified, all lists with all processing types will be included.

querystring

The `query` that will be used to search for lists by list name. If no `query` is provided, then the results will include all lists.

sortstring

Sort field and order

json

{
  "additionalProperties": [
    "string"
  ],
  "offset": 0,
  "count": 0,
  "listIds": [
    "string"
  ],
  "objectTypeId": "string",
  "processingTypes": [
    "string"
  ],
  "query": "string",
  "sort": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{postCrmV3ListsSearchCrmV3ListsSearch.response.data.<field>}}.

hasMoreboolean

Whether or not there are more results to page through.

listsarray<object>

The lists that matched the search criteria.

additionalPropertiesobjectrequired

The name and value of any additional properties that exist for this list and that were included in the search request.

createdAtstring (date-time)

The time when the list was created.

createdByIdstring

The ID of the user that created the list.

deletedAtstring (date-time)

The time when the list was deleted.

filtersUpdatedAtstring (date-time)

The time when the filters for this list were last updated.

listIdstringrequired

The **ILS ID** of the list.

listVersioninteger (int32)required

The version of the list.

namestringrequired

The name of the list.

objectTypeIdstringrequired

The object type of the list.

processingStatusstringrequired

The processing status of the list.

processingTypestringrequired

The processing type of the list.

updatedAtstring (date-time)

The time the list was last updated.

updatedByIdstring

The ID of the user that last updated the list.

offsetinteger (int32)

Value to be passed in a future request to paginate through list search results.

totalinteger (int32)

The total number of lists that match the search criteria.

json

{
  "hasMore": false,
  "lists": [
    {
      "additionalProperties": {
        "hs_last_record_added_at": 1695938616824,
        "hs_list_reference_count": 0,
        "hs_list_size": 59,
        "hs_list_size_week_delta": -1
      },
      "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": "COMPLETED",
      "processingType": "SNAPSHOT",
      "updatedById": "1"
    }
  ],
  "offset": 0,
  "total": 0
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.

Was this page helpful?