HubSpot API Data Model
Lists |
Fetch Multiple ListsFetch multiple lists in a single request by **ILS list ID**. The response will include the definitions of all lists that exist for the `listIds` provided.
Catalog: Lists3
Schema: Lists
Label: {res:itgen_hubspot_lists_plural}
Retrieve: true
Insert: true
Update: false
Delete: false
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function Lists. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
includeFilters |
boolean |
☐ |
|
A flag indicating whether or not the response object list definitions should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response. |
Columns of Table Function
The columns of the table function Lists are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
createdAt |
datetime |
Created at |
☐ |
The time when the list was created. |
createdById |
string |
Created by ID |
☐ |
The ID of the user that created the list. |
deletedAt |
datetime |
Deleted at |
☐ |
The time when the list was deleted. |
filterBranch_filterBranchOperator |
string |
{res:itgen_hubspot_filterbranch_filterbranchoperator} |
☐ |
|
filterBranch_filterBranchType |
string |
{res:itgen_hubspot_filterbranch_filterbranchtype} |
☐ |
|
filtersUpdatedAt |
datetime |
{res:itgen_hubspot_filtersupdatedat} |
☐ |
The time when the filters for this list were last updated. |
listId |
string |
{res:itgen_hubspot_listid} |
☐ |
The **ILS ID** of the list. |
listVersion |
int32 |
{res:itgen_hubspot_listversion} |
☐ |
The version of the list. |
name |
string |
Name |
☐ |
The name of the list. |
objectTypeId |
string |
Ojbect Type ID |
☐ |
The object type of the list. |
processingStatus |
string |
{res:itgen_hubspot_processingstatus} |
☐ |
The processing status of the list. |
processingType |
string |
{res:itgen_hubspot_processingtype} |
☐ |
The processing type of the list. |
size |
int64 |
Size |
☐ |
|
updatedAt |
datetime |
Updated at |
☐ |
The time the list was last updated. |
updatedById |
string |
Updated by ID |
☐ |
The ID of the user that last updated the list. |
18-12-2024 20:09 Version 24.1.33-BETA+5180
