HubSpot API Data Model
TableNameRowsByTableIdOrName |
Get rows for a tableReturns a set of rows in the published version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.**Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.
Catalog: Hubdb3
Schema: Rows
Label: {res:itgen_hubspot_tablenamerowsbytableidorname_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 TableNameRowsByTableIdOrName. 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 |
|---|---|---|---|---|
after |
string |
☐ |
|
The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results. |
archived |
boolean |
☐ |
|
|
tableIdOrName |
string |
☑ |
|
The ID or name of the table to query. |
Columns of Table Function
The columns of the table function TableNameRowsByTableIdOrName are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
paging_next_after |
string |
{res:itgen_hubspot_paging_next_after} |
☐ |
|
paging_next_link |
string |
{res:itgen_hubspot_paging_next_link} |
☐ |
|
paging_next_offset |
int32 |
{res:itgen_hubspot_paging_next_offset} |
☐ |
|
paging_prev_before |
string |
{res:itgen_hubspot_paging_prev_before} |
☐ |
|
paging_prev_link |
string |
{res:itgen_hubspot_paging_prev_link} |
☐ |
|
total |
int32 |
{res:itgen_hubspot_total} |
☐ |
|
type |
string |
Type |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180
