List blog authors (v3)

GET /blogs/v3/blog-authors

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get the list of blog authors. Supports paging and filtering.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.

Optional query string filters & options

Some parameters support "range" filters via double-underscored param suffixes, like '__gt'. If a parameter supports a filter type of 'gt', that means you can append a double-underscore and 'gt' to the parameter name to find all items greater than a specified value.

For example, the following query will find all items with the 'updated' time greater than 1364424600000: https://api.hubapi.com/blogs/v3/blog-authors?hapikey=demo&created__gt=1364424600000

Parameter name Description
id Search for authors by id. Supports exact value matching and the 'in' range filter (e.g. id__in=348109009,348109019)
fullName Search for authors by full name. Supports exact value matching, 'contains' searching, and 'icontains' case-insensitive searching (e.g. name__icontains=author1,author2)
slug Search for authors by slug. Supports exact value matching
created Filter results by creation date, in milliseconds since the epoch. Supports exact value matching and the following range filters: range, gt, gte, lt, lte
updated Filter results by last updated date, in milliseconds since the epoch. Supports exact value matching and the following range filters: range, gt, gte, lt, lte
email Search for authors by email. Supports exact value matching
limit The maximum number of items to return. Defaults to 20.
offset The offset from the beginning of the result set from which to start returning results. Used for paging. Defaults to 0.
casing Use the casing=snake parameter to change the API's casing for all query parameters (including those above) and JSON fields (below) to snake_case, rather than camelCase, which is the default. This option is provided for backwards-compatibility and ease of migration from Content v2 APIs, which used snake_case.

JSON Fields returned in the response

Field name Type Description
id string The unique id of the author
portalId string The hub id
created long When the author was first created, in milliseconds since the epoch
updated long When the author was last updated, in milliseconds since the epoch
deletedAt long When the author was deleted, in milliseconds since the epoch. Zero if the author was never deleted. Use a DELETE request to properly soft delete an author - do not set this value directly.
fullName string The full name of the author
email string The email address of the author
userId Long The userid of the author, if associated with a hubspot account
username string The username of the author, if associated with a hubspot account
slug string The URL-friendly version of the author, used in blog urls
displayName string The display name of the author
bio string Author's bio text
googlePlus string Author's Google Plus url
website string Author's website url
twitter string Author's twitter url
linkedin string Author's LinkedIn url
facebook string Author's Facebook url
avatar string Author's avatar url
gravatarUrl string Author's gravatar url
twitterUsername string Author's twitter username, generated from their twitter url
hasSocialProfiles boolean true if at least one social network (facebook, twitter, googlePlus, likedin) has a url