List Calendar Tasks

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Marketing

Retrieve task events for Calendar. A shortcut of the standard events call for finer-grained control. Supports filtering.

Note: This endpoint is for tasks on the Marketing calendar. For tasks associated with the CRM and CRM objects, please see the Engagements API

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.
startDate	startDate=X - Used in the request URL	The beginning value of the query range, in UTC, in milliseconds
endDate	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.
campaignGuid	filter tasks by campaign guid. Multiple can be specified.
includeNoCampaigns	include 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 task is set to be due, in milliseconds since the epoch
eventType	string	Type of calendar event; for tasks this is always PUBLISHING_TASK
category	string	type of task; one of BLOG_POST, EMAIL, LANDING_PAGE, CUSTOM
categoryId	integer	numeric value corresponding to the type of task; one of 3 (BLOG_POST), 2 (EMAIL), 1 (LANDING_PAGE), 0 (CUSTOM)
contentId	long	id value of the COS content object associated with the task, null if nothing associated
state	string	value of TODO or DONE
campaignGuid	string	value of campaign GUID associated with Task
contentGroupId	long	The ID of the content group (aka blog) that the associated Blog Post belongs to, if any. Otherwise null. Only populated for single task GETs and for Blog Post Tasks.
topicIds	list of longs	The list of ids of topics associated with the associated Blog Post, if any. Otherwise null. Only populated for single task GETs and for Blog Post Tasks.
name	string	Name of Task
description	string	description of Task
url	string	Reserved
ownerId	long	HubSpot id of the user that the task is assigned to
createdBy	long	HubSpot id of the user that the task was created by
previewKey	string	Reserved
socialUserName	string	Reserved
socialDisplayName	string	Reserved
avatarUrl	string	Reserved
recurring	boolean	is the task recurring

Developers