Method Details
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Search for blog authors by name, email, and url slug. Supports paging, ordering, and casing changes.
There's a new version of the HubSpot API
We're also working on a new documentation website, you're invited to check it out and give us your feedback.
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Search for blog authors by name, email, and url slug. Supports paging, ordering, and casing changes.
| Required Parameters | How to use | Description |
|---|---|---|
| OAuth access token or private app access token | Authorization: Bearer {token} header | Used to authenticate the request. Please see this page for more details about authentication. |
| Parameter name | Description |
|---|---|
| order | the attribute to order the results by. Prepend a "-" to invert |
| 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. |
| q | Search for authors whose names, emails, or url slugs contain the given string (q=X). |
| active | Filter authors by whether or not they have published blog posts (true or false) |
| blog | Filter authors by the blog they have published to (value is a blog ID) |
| 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 |
| 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 |
| publicUrl | string | Author url based on your primary blog |
| totalPosts | Long | The total count of posts attributed to this author |
| livePosts | Long | The total count of published posts attributed to this author |
| status | string | "active" if author has any published posts, "inactive" otherwise |
| 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 |
| string | Author's twitter url | |
| string | Author's LinkedIn url | |
| 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 |