HubSpot API Data Model
LandingPageFolders |
Get all Landing Page FoldersGet the list of Landing Page Folders. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.
Catalog: Pages3
Schema: LandingPages
Label: {res:itgen_hubspot_landingpagefolders_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 LandingPageFolders. 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 |
☐ |
|
Specifies whether to return deleted Folders. Defaults to `false`. |
createdAfter |
datetime |
☐ |
|
Only return Folders created after the specified time. |
createdAt |
datetime |
☐ |
|
Only return Folders created at exactly the specified time. |
createdBefore |
datetime |
☐ |
|
Only return Folders created before the specified time. |
property |
string |
☐ |
|
|
updatedAfter |
datetime |
☐ |
|
Only return Folders last updated after the specified time. |
updatedAt |
datetime |
☐ |
|
Only return Folders last updated at exactly the specified time. |
updatedBefore |
datetime |
☐ |
|
Only return Folders last updated before the specified time. |
Columns of Table Function
The columns of the table function LandingPageFolders 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 |
|---|---|---|---|---|
category |
int32 |
Category |
☐ |
The type of object this folder applies to. Should always be LANDING_PAGE. |
created |
datetime |
Created at |
☐ |
|
deletedAt |
datetime |
Deleted at |
☐ |
The timestamp (ISO8601 format) when this content folder was deleted. |
id |
string |
ID |
☐ |
The unique ID of the content folder. |
name |
string |
Name |
☐ |
The name of the folder which will show up in the app dashboard |
parentFolderId |
int64 |
Parent Folder ID |
☐ |
The ID of the content folder this folder is nested under |
updated |
datetime |
Updated at |
☐ |
|
18-12-2024 20:09 Version 24.1.33-BETA+5180
