There's a new version of the HubSpot API
As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.
Please note: all calendar API endpoints are being sunset and are no longer supported. These APIs will no longer function, and data from the marketing calendar will no longer be available via API. These APIs will be removed on August 31, 2023.
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Required Scope:
| 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. |
| Start Date | startDate=X - Used in the request URL | The beginning value of the query range, in UTC, in milliseconds |
| End Date | endDate=X - Used in the request URL | The end value of the query range, in UTC, in milliseconds |
| Parameter name | Description |
|---|---|
| limit | The maximum number of items to return. Defaults to 100. |
| offset | Starting value to page by. Defaults to 0. |
| contentCategory | The category of content to filter by, values include "blog-post", "email", "recurring-email" and "landing-page". Multiple can be specified. Defaults to not filtering, showing all types |
| campaignGuid | Show tasks by campaign guid. Multiple can be specified. |
| includeNoCampaigns | Show tasks without a campaign specified (true, false). Defaults to false. |
| Field name | Type | Description |
|---|---|---|
| id | string | The unique id of the task |
| portalId | string | The hub id |
| eventDate | long | When the event is/ was scheduled to be published, in milliseconds since the epoch |
| eventType | string | Type of calendar event; for tasks this is PUBLISHING_TASK, for COS Items, this is CONTENT, for social media events, this is SOCIAL |
| category | string | type of event; one of email, recurring-email, blog-post, landing-page, legacy-page, site-page |
| categoryId | integer | one of 2 (email, recurring-email), 3 (blog-post), 1 (landing-page), 5 (legacy-page), 4 (site-page) |
| contentId | long | id value of the COS content object associated with the event, null for if nothing associated |
| state | string | one of SCHEDULED, PUBLISHED, PUBLISHED_OR_SCHEDULED |
| campaignGuid | string | value of campaign GUID associated with Content |
| contentGroupId | long | reserved |
| topicIds | list of longs | reserved |
| name | string | Name of Event |
| description | string | description of Event |
| url | string | public url of content item |
| ownerId | long | reserved |
| createdBy | long | HubSpot id of the user that the event was created by |
| previewKey | string | preview key of content object; used for showing previews of unpublished items. |
| socialUserName | string | reserved |
| socialDisplayName | string | reserved |
| avatarUrl | string | reserved |
| isRecurring | boolean | is the event recurring? (true, false) |
