BlogAuthorsByObjectId: HubSpot Blog Authors by Object ID |
Retrieve a Blog AuthorRetrieve the Blog Author object identified by the id in the path.
Catalog: Authors
Schema: Basic
Label: Blog Authors by Object ID
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 BlogAuthorsByObjectId. 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 |
|---|---|---|---|---|
archived |
boolean |
☐ |
|
Whether to return only results that have been archived. |
objectId |
string |
☑ |
|
|
property |
string |
☐ |
|
|
Columns of Table Function
The columns of the table function BlogAuthorsByObjectId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
avatar |
string |
Avatar |
☐ |
URL to the blog author's avatar, if supplying a custom one. |
bio |
string |
Biography |
☐ |
A short biography of the blog author. |
created |
datetime |
Created at |
☐ |
The timestamp (ISO8601 format) when this Blog Author was created. |
deletedAt |
datetime |
Deleted at |
☐ |
The timestamp (ISO8601 format) when this Blog Author was deleted. |
displayName |
string |
Display Name |
☐ |
The full name of the Blog Author to be displayed. |
string |
☐ |
Email address of the Blog Author. |
||
string |
☐ |
URL to the Blog Author's Facebook page. |
||
fullName |
string |
Full Name |
☐ |
The full, unabbreviated name of the blog author, typically their first and last name combined. |
id |
string |
ID |
☐ |
The unique ID of the Blog Author. |
language |
string |
Language |
☐ |
The explicitly defined ISO 639 language code of the blog author. |
string |
☐ |
URL to the blog author's LinkedIn page. |
||
name |
string |
Name |
☐ |
The name field for the blog author. (This appears to be a shorter or alternative name field compared to fullName.) |
slug |
string |
Slug |
☐ |
A URL-friendly identifier for the blog author that can be used to reference the author in URLs. Typically generated from the author's name and contains lowercase letters, hyphens, and underscores. |
translatedFromId |
int64 |
Translated from ID |
☐ |
ID of the primary blog author this object was translated from. |
string |
☐ |
URL or username of the Twitter account associated with the Blog Author. This will be normalized into the Twitter url for said user. |
||
updated |
datetime |
Updated at |
☐ |
The timestamp (ISO8601 format) when this Blog Author was updated. |
website |
string |
Website |
☐ |
URL to the website of the Blog Author. |
HubSpot API Data Model