HubSpot API Data Model
ListById |
Fetch List by IDFetch a single list by **ILS list ID**.
Catalog: Lists3
Schema: Lists
Label: {res:itgen_hubspot_listbyid_plural}
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function ListById. 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 definition should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response. |
listId |
string |
☑ |
|
The **ILS ID** of the list to fetch. |
Columns of Table Function
The columns of the table function ListById are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
list_createdAt |
datetime |
{res:itgen_hubspot_list_createdat} |
☐ |
The time when the list was created. |
list_createdById |
string |
{res:itgen_hubspot_list_createdbyid} |
☐ |
The ID of the user that created the list. |
list_deletedAt |
datetime |
{res:itgen_hubspot_list_deletedat} |
☐ |
The time when the list was deleted. |
list_filterBranch_filterBranchOperator |
string |
{res:itgen_hubspot_list_filterbranch_filterbranchoperator} |
☐ |
|
list_filterBranch_filterBranchType |
string |
{res:itgen_hubspot_list_filterbranch_filterbranchtype} |
☐ |
|
list_filtersUpdatedAt |
datetime |
{res:itgen_hubspot_list_filtersupdatedat} |
☐ |
The time when the filters for this list were last updated. |
list_listId |
string |
{res:itgen_hubspot_list_listid} |
☐ |
The **ILS ID** of the list. |
list_listVersion |
int32 |
{res:itgen_hubspot_list_listversion} |
☐ |
The version of the list. |
list_name |
string |
{res:itgen_hubspot_list_name} |
☐ |
The name of the list. |
list_objectTypeId |
string |
{res:itgen_hubspot_list_objecttypeid} |
☐ |
The object type of the list. |
list_processingStatus |
string |
{res:itgen_hubspot_list_processingstatus} |
☐ |
The processing status of the list. |
list_processingType |
string |
{res:itgen_hubspot_list_processingtype} |
☐ |
The processing type of the list. |
list_size |
int64 |
{res:itgen_hubspot_list_size} |
☐ |
|
list_updatedAt |
datetime |
{res:itgen_hubspot_list_updatedat} |
☐ |
The time the list was last updated. |
list_updatedById |
string |
{res:itgen_hubspot_list_updatedbyid} |
☐ |
The ID of the user that last updated the list. |
18-12-2024 20:09 Version 24.1.33-BETA+5180
