HubSpot Connector Objects (hubspot Schema)

Name	Description
AnalyticsBreakdowns	Get analytics data broken down by the specified category.
AnalyticsContents	Get analytics data for your HubSpot hosted content. This would include your website and landing pages, as well as any blog pages hosted on HubSpot.
AnalyticsEventCompletions	Get analytics data for event completion objects.
AnalyticsForms	Get analytics data for form objects.
AnalyticsSessions	Get analytics data broken down by sessions.
AnalyticsSocialAssists	Get analytics data for social assist objects.
AnalyticsViews	Get the details for the analytics views set up in the portal.
BlogAuthors	Retrieve the available blog authors in HubSpot.
BlogPosts	Retrieve the available blog posts in HubSpot.
Blogs	Retrieve the available blogs in HubSpot.
BlogTopics	Retrieve the available blog topics in HubSpot.
Comments	Retrieve the available comments from your blog in HubSpot.
Companies	Companies may be kept track of in HubSpot just like contacts. They can be added to, updated, and removed from this table.
CompanyProperties	Company properties are the standard and custom pieces of field data that appear in HubSpot.
CompanyPropertiesHistory	A list of the historical values of the property.
CompanyPropertyGroups	Company property groups in HubSpot offer a way of organizing individual types of properties for companies. Each company property must belong to a property group.
ContactFormSubmissions	List of Contact's Form Submissions.
ContactIdentityProfiles	List of Contact's Identity profiles
ContactListMemberships	Returns the list memberships of contacts in HubSpot.
ContactLists	Contact lists in HubSpot can be used to group together contacts with similar characteristics.
ContactProperties	Contact properties are the standard and custom pieces of field data that appear in HubSpot.
ContactPropertiesHistory	A list of the historical values of the property.
ContactPropertyGroups	Contact property groups in HubSpot offer a way of organizing individual types of properties for contacts. Each contact property must belong to a property group.
Contacts	Your contacts in HubSpot may be used for marketing campaigns and can be retrieved, inserted, updated, and deleted from this table.
ContactsInList	Retrieves the contacts in a given list in HubSpot. New contacts may be added to the list or removed from it. A ListId must be specified to retrieve the current contacts in the list.
ContactStatistics	Basic contact statistics that can be retrieved from HubSpot such as the total number and when the last new contact was created.
CrmAssociations	Query the available CRM Associations in HubSpot.
DealAssociations	Deal associations can be used to insert or delete individual associations with Deals.
DealPipelines	Deal pipelines may be used to organize what stages a given deal is on.
DealPipelineStages	The stages for a given Deal Pipeline.
DealProperties	Deal properties are the standard and custom pieces of field data that appear in HubSpot.
DealPropertiesHistory	A list of the historical values of the property.
DealPropertyGroups	Contact property groups in HubSpot offer a way of organizing individual types of properties for contacts. Each contact property must belong to a property group.
Deals	Your deals in HubSpot which may be used for making offers to potential customers.
DealStages	The stages for a given Deal.
Domains	Retrieve the available domains in HubSpot.
EmailCampaignEvents	The events associated with an email campaign or a recipient.
EmailCampaigns	Email campaigns in HubSpot allow you to keep track of email marketing campaigns.
EmailSubscriptions	The subscription types a given email is subscribed to. An email must be specified to return results. Subscriptions may be removed by deleting them.
EmailSubscriptionTypes	A list of email subscription types for a HubSpot hub.
Engagements	Engagements represent any of a number of different types of engagements you have in HubSpot.
EngagementScheduledTasks	List of tasks scheduled for an engagement.
EngagementsScheduledTasks	List of tasks scheduled for an engagement.
Enrollments	Get workflows a contact is currently enrolled in.
Events	Returns all of the event definitions in a given portal.
Files	Retrieves information about the available files in HubSpot.
Folders	Retrieves information about the available folders in HubSpot.
FormFields	Get fields of HubSpot Forms.
Forms	Create and manage HubSpot Forms.
FormSubmissions	Get the submissions for the specified form.
LineItemProperties	Get all of the properties for the line item object type, along with the property definitions.
LineItems	Query the available line items in HubSpot.
MarketingEmails	Create and manage HubSpot Marketing Emails.
Pages	Retrieve the available pages in HubSpot.
ProductProperties	Get all of the properties for the product object type, along with the property definitions.
Products	Query the available products in HubSpot.
SocialMediaChannels	List available social media channels in HubSpot
SocialMediaMessages	Create and manage HubSpot social media messages.
Templates	Retrieve the available templates in HubSpot.
TicketProperties	Get all of the properties for the ticket object type, along with the property definitions.
TicketPropertyGroups	Get all of the property groups for the specified Ticket object type.
Tickets	Get all tickets from a portal.
UrlMappings	Retrieve the available url mappings in HubSpot.
Workflows	Select and manage HubSpot workflows.

Name	Type	ReadOnly	FilterOnly	Description
Totals	String	True	No	Data will be the totals rolled up.
Sources	String	True	No	Data broken down by traffic source.
Geolocation	String	True	No	Data broken down by geographic location.
UtmCampaigns	String	True	No	Data broken down by the standard UTM campaigns parameter.
UtmContents	String	True	No	Data broken down by the standard UTM contents parameter.
UtmMediums	String	True	No	Data broken down by the standard UTM mediums parameter.
UtmSources	String	True	No	Data broken down by the standard UTM sources parameter.
UtmTerms	String	True	No	Data broken down by the standard UTM terms parameterpages.
FirstDrilldown	String	False	No	Used to drilldown into the data. This parameter is designed to reflect the functionality of the HubSpot sources reports.
SecondDrilldown	String	False	No	Used to further drill down into the data. Similar to FirstDrilldown, this reflects the functionality of the sources report.
BounceRate	Double	False	No	The rate of bounces.
ContactToCustomerRate	Double	False	No	The rate of contacts to customers.
Contacts	Long	False	No	The number of generated contacts.
Customers	Long	False	No	The number of generated customers.
Leads	Long	False	No	The number of leads.
MarketingQualifiedLeads	Long	False	No	The number of leads which are more likely to become customers.
NewVisitorSessionRate	Double	False	No	The session rate for new visitors.
Opportunities	Long	False	No	The number of opportunitites.
PageviewsPerSession	Double	False	No	The ratio of page views over sessions.
RawViews	Long	False	No	The number of raw views.
SalesQualifiedLeads	Long	False	No	The number of prospective customers that are considered ready for the sales process.
SessionToContactRate	Double	False	No	The ratio of sessions over generated contacts.
Subscribers	Long	False	No	The number of subscribers.
TimePerSession	Double	False	No	The time per session.
Visitors	Long	False	No	The number of visitors.
Visits	Long	False	No	The number of visits.
BreakdownDate	Date	False	No	The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.
StartDate	Date	False	Yes	The beginning value of the query range.
EndDate	Date	False	Yes	The ending value of the query range.
Granularity	String	False	Yes	The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String	False	Yes	Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String	False	Yes	Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String	False	Yes	The ID of an Analytics view. If included, the returned data will only include data that matches the view.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
LandingPages	String	True	No	Pull data for landing pages.
StandardPages	String	True	No	Pull data for website pages.
BlogPosts	String	True	No	Pull data for individual posts.
ListingPages	String	True	No	Pull data for blog listing pages.
KnowledgeArticles	String	True	No	Pull data for knowledge base articles.
AllPages	String	True	No	Get data for all URLs with data collected by HubSpot tracking code. The results are broken down by URL.
Contacts	Long	False	No	The total number of new contacts generated.
ContactsPerPageview	Double	False	No	The ratio of contacts to raw views.
CtaViews	Long	False	No	The number of CallsToAction views.
Entrances	Long	False	No	The number of entrances.
Exits	Long	False	No	The number of exits.
ExitsPerPageview	Double	False	No	The ratio of exits over page views.
Leads	Long	False	No	The number of leads.
PageBounceRate	Double	False	No	The rate of page bounces.
PageBounces	Long	False	No	The number of page bounces.
PageTime	Long	False	No	The time spent on page.
RawViews	Long	False	No	The number of raw views.
Submissions	Long	False	No	The number of submissions.
SubmissionsPerPageview	Double	False	No	The ratio of submissions over page views.
TimePerPageview	Double	False	No	The ratio of time over page views.
BreakdownDate	Date	False	No	The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.
StartDate	Date	False	Yes	The beginning value of the query range.
EndDate	Date	False	Yes	The ending value of the query range.
Granularity	String	False	Yes	The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String	False	Yes	Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String	False	Yes	Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String	False	Yes	The ID of an Analytics view. If included, the returned data will only include data that matches the view.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
EventCompletions	String	True	No	Analytics data for event completions.
Completions	Long	False	No	The number of event completions.
BreakdownDate	Date	False	No	The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.
StartDate	Date	False	Yes	The beginning value of the query range.
EndDate	Date	False	Yes	The ending value of the query range.
Granularity	String	False	Yes	The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String	False	Yes	Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String	False	Yes	Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String	False	Yes	The ID of an Analytics view. If included, the returned data will only include data that matches the view.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Forms	String	True	No	Analytics data for forms.
Completions	Long	False	No	The number of completions.
FormViews	Long	False	No	The number of times the form has been viewed.
Installs	Long	False	No	The number of installs.
Interactions	Long	False	No	The number of interactions.
Submissions	Long	False	No	The number of submissions.
Visibles	Long	False	No	The number of times the form has been visible.
BreakdownDate	Date	False	No	The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.
StartDate	Date	False	Yes	The beginning value of the query range.
EndDate	Date	False	Yes	The ending value of the query range.
Granularity	String	False	Yes	The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String	False	Yes	Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String	False	Yes	Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String	False	Yes	The ID of an Analytics view. If included, the returned data will only include data that matches the view.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Sessions	String	True	No	Analytics data for sessions.
Desktop	Long	False	No	Desktop sessions.
DirectTraffic	Long	False	No	Direct sessions.
EmailMarketing	Long	False	No	Email marketing sessions.
Mobile	Long	False	No	Mobile sessions.
OrganicSearch	Long	False	No	Organic search sessions.
OtherCampaigns	Long	False	No	Other campaigns sessions.
Others	Long	False	No	Other sessions.
PaidSearch	Long	False	No	Paid search sessions.
PaidSocial	Long	False	No	Paid social sessions.
Referrals	Long	False	No	Referrals sessions.
SocialMedia	Long	False	No	Social media sessions.
FirstDrilldown	String	False	No	Used to drilldown into the data. This parameter is designed to reflect the functionality of the HubSpot sources reports.
SecondDrilldown	String	False	No	Used to further drill down into the data. Similar to FirstDrilldown, this reflects the functionality of the sources report.
BreakdownDate	Date	False	No	The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.
StartDate	Date	False	Yes	The beginning value of the query range.
EndDate	Date	False	Yes	The ending value of the query range.
Granularity	String	False	Yes	The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String	False	Yes	Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String	False	Yes	Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String	False	Yes	The ID of an Analytics view. If included, the returned data will only include data that matches the view.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
SocialAssists	String	True	No	Analytics data for social assists.
RawViews	Long	False	No	The number of raw views.
BreakdownDate	Date	False	No	The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.
StartDate	Date	False	Yes	The beginning value of the query range.
EndDate	Date	False	Yes	The ending value of the query range.
Granularity	String	False	Yes	The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String	False	Yes	Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String	False	Yes	Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String	False	Yes	The ID of an Analytics view. If included, the returned data will only include data that matches the view.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Id of the analytic view.
Title	String	True	No	Title of the analytic view.
CreatorId	Long	True	No	Id of the creator.
CreatedAt	Date	True	No	Date of the creation.
UpdaterId	Long	True	No	Id of the updater.
UpdatedDate	Date	True	No	Date of the update.
DeletedAt	Date	True	No	Date of the deletion.
ContainsLegacyReportProperties	Boolean	True	No	Determines if the view contains legacy report properties.
ReportPropertyFiltersAggregate	String	True	No	Report property filters of the analytic view.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The id of the author.
FullName	String	True	No	The first and last name of the blog author.
CreatedAt	Datetime	True	No	When the blog author was first created.
Slug	String	True	No	The path appended to the blog URL at which the author page will live.
DeletedAt	Datetime	True	No	When the author was deleted.
Email	String	True	No	The email address of the blog author.
FacebookProfile	String	True	No	The blog author's Facebook page.
GooglePlusProfile	String	True	No	The blog author's Google Plus profile.
LinkedInProfile	String	True	No	The blog author's LinkedIn profile
TwitterProfile	String	True	No	The blog author's twitter handle.
AvatarUrl	String	True	No	A small photo or image of the blog author.
UserId	Long	True	No	The HubSpot user id of the blog author.
Username	String	True	No	The HubSpot username of the blog author.
Website	String	True	No	The blog author's web site.
UpdatedAt	Datetime	True	No	When the blog author was last updated.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	The id of the blog post.
AuthorUserId	Long	True		No	The HubSpot user id of the blog author.
AuthorName	String	True		No	The HubSpot username of the blog author.
BlogAuthorId	Long	True	BlogAuthors.Id	No	The integer id of the blog author, look up via the blog authors end.
CampaignId	String	True	EmailCampaigns.Id	No	The guid of the marketing campaign this post is associated with.
ContentGroupId	Long	True		No	The id of the blog that this post belongs to. Get the id by looking at the blog API.
TopicIds	String	True		No	The individual topics the post is associated with.
CreatedAt	Datetime	True		No	When the post was first created.
ArchivedAt	Datetime	True		No	When the post was deleted.
ArchivedInDashboard	Boolean	True		No	If True, the post will not show up in your dashboard, although the post will still be live.
Name	String	True		No	The internal name of the blog post.
Slug	String	True		No	The path of the URL on which the post will live.
UpdatedAt	Datetime	True		No	When the post was last updated.
PublishedAt	Datetime	True		No	When the post was published.
PostSummary	String	True		No	The summary of the blog post that will appear on the main listing page.
PostBody	String	True		No	The HTML of the main post body.
Url	String	True		No	The full URL with domain and scheme to the blog post. Will return a 404 if the post is not yet published.
ExtraUrlParameters	String	True		No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The id of the blog.
Name	String	True	No	The internal name of the blog.
AllowComments	Boolean	True	No	Are comments enabled for the blog.
CommentShouldCreateContact	Boolean	True	No	Boolean indicating if an email address that is not listed in your HubSpot contacts creates a comment, should this user be automatically added to your HubSpot contacts.
CreatedAt	Datetime	True	No	When the post was first created.
HTMLTitle	String	True	No	The title in the title attribute of the page, shows up in the browsers title bar and as the title in Google search results.
Language	String	True	No	The language of the blog.
PostsPerListingPage	Long	True	No	The number of posts listed per page in the HTML viewable blog.
PostsPerRSSFeed	Long	True	No	The number of posts listed per page in the RSS feed for the blog.
PublicTitle	String	True	No	The header of the blog.
RootURL	String	True	No	The full URL with domain and scheme to the blog post.
ShowSocialLinkFacebook	Boolean	True	No	Boolean indicating if a social link for Facebook should be displayed on the blog.
ShowSocialLinkGoogle	Boolean	True	No	Boolean indicating if a social link for Google Plus should be displayed on the blog.
ShowSocialLinkLinkedIn	Boolean	True	No	Boolean indicating if a social link for LinkedIn should be displayed on the blog.
ShowSocialLinkTwitter	Boolean	True	No	Boolean indicating if a social link for Twitter should be displayed on the blog.
Slug	String	True	No	The path of the URL on which the post will live.
UpdatedAt	Datetime	True	No	When the post was last updated.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The blog topic id.
CreatedAt	Datetime	True	No	When the topic was created
DeletedAt	Datetime	True	No	When the topic was deleted.
Description	String	True	No	A description of the topic.
Name	String	True	No	The name of the topic.
Slug	String	True	No	How the topic will appear in the url.
UpdatedAt	Datetime	True	No	When the topic was last updated.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	The id of the comment.
State	String	True		No	The current state of the comment.
PostId	Long	True	BlogPosts.Id	No	The id of the parent blog post.
Comment	String	True		No	The full text of the comment.
CommentAuthorEmail	String	True		No	Email address of the user submitting the comment.
CommentAuthorName	String	True		No	Name of the user submitting the comment.
ContentPermalink	String	True		No	A permanent link for the parent post of the comment.
ContentTitle	String	True		No	The title of the parent post for the comment.
CreatedAt	Datetime	True		No	When the comment was made.
DeletedAt	Datetime	True		No	When the comment was deleted.
FirstName	String	True		No	The first name of the user who made the comment.
LastName	String	True		No	The last name of the user who made the comment.
UserEmail	String	True		No	Email address of the user submitting the comment.
UserUrl	String	True		No	A url to the user's website if available.
ExtraUrlParameters	String	True		No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
CompanyId [KEY]	Long	True	No	The id of the company in HubSpot.
IsDeleted	Boolean	True	No	A boolean indicating if the company is deleted.
OtherProperties	String	True	No	Other properties about the company will dynamically obtained at runtime and will vary depending on the company properties specific to your HubSpot HUB.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Name [KEY]	String	False		No	The name of the contact property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False		No	The human readable label for the company property that will display in the HubSpot UI.
FieldType	String	False		No	The type of field that will display on the screen for the company property.
Type	String	False		No	The stored machine type for the company property.
GroupName	String	False	ContactPropertyGroups.Name	No	The group the company property is a part of.
Description	String	False		No	A description of what the property is for.
DisplayMode	String	False		No	How the property will be displayed.
DisplayOrder	Integer	False		No	The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False		No	Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False		No	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False		No	Boolean indicating if the property is calculated.
IsHidden	Boolean	False		No	Boolean indicating if the property is hidden.
IsHubspotDefined	Boolean	False		No	Boolean indicating if the property is defined by HubSpot.
MutableDefinitionNotDeletable	Boolean	False		No	Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		No	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False		No	Boolean indicating if the value of the property is read only.
OptionsAggregate	String	False		No	An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True		No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
PropertyName	String	False	No	The name of the contact property.
Value	String	False	No	The historical value of the property.
Timestamp	Datetime	False	No	Datetime when the property was updated
Source	String	False	No	The method by which the property was changed
SourceId	String	False	No	Additional data realted to the source-type. May not be populated for all source-types.
SourceVid	String	False	No
CompanyId	String	False	No	The Id of the Company that the property belongs to.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Name [KEY]	String	False	No	The name of the contact property group.
DisplayName	String	False	No	The display name of the contact group.
DisplayOrder	Integer	False	No	The numerical order of the contact group with respect to other contact groups.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
ContactVID	Long	False	Contacts.VID	No	The unique id of the task.
FormId	String	False	Forms.GUID	No	The GUID of the form that the subission belongs to.
ConversionId	String	False		No	A Unique ID for the specific form conversion.
PortalId	Long	False		No	The Portal ID (Hub ID) that the submission belongs to
Timestamp	Datetime	False		No	The time the submission occurred.
Title	String	False		No	The title of the page that the form was submitted on.
PageId	Long	False	Pages.Id	No	Id of the page that the form was submitted on.
PageTitle	String	False		No	Title of the page that the form was submitted on.
PageURL	String	False		No	The URL that the form was submitted on.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
ContactVID	Long	False	Contacts.VID	No	The unique id for the contact.
Type	String	False		No	The type of the identity, one of EMAIL or LEAD_GUID.
Value	String	False		No	The value of the identity.
Timestamp	Datetime	False		No	Time when the identity was created.
SavedAt	Datetime	False		No	Time when the identity was last updated.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
VID [KEY]	Long	True	Contacts.VID	No	The id of the contact on the list.
ListId [KEY]	Long	True	ContactLists.ListId	No	The static id of the list.
Email	String	True		No	The static id of the list.
TimeAddedToList	Datetime	False		No	The datetime when the contact was added to the list.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
ListId [KEY]	Long	True	No	The unique id of the list.
Name	String	False	No	The name of the contact list.
CreatedAt	Datetime	True	No	When the contact list was created.
UpdatedAt	Datetime	True	No	When the contact list was last updated.
IsDynamic	Boolean	False	No	A boolean indicating if the contact list is dynamic.
FiltersAggregate	String	False	No	An aggregate of filters that a dynamic contact list uses to determine if a newly created contact should be added to the list.
InternalListId	Long	True	No	An internal id for the contact list.
LastProcessingStateChangeAt	Datetime	True	No	Metadata describing when the last processing state was changed.
ProcessingState	String	True	No	Metadata indicating the current stage of processing.
LastSizeChangeAt	Datetime	True	No	Metadata describing when the last time the contact list size was changed.
ListSize	Long	True	No	Metadata indicating the size of the contact list.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Name [KEY]	String	False		No	The name of the contact property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False		No	The human readable label for the contact property that will display in the HubSpot UI.
FieldType	String	False		No	The type of field that will display on the screen for the company property.
Type	String	False		No	The stored machine type for the company property.
GroupName	String	False	ContactPropertyGroups.Name	No	The group the company property is a part of.
Description	String	False		No	A description of what the property is for.
DisplayMode	String	False		No	How the property will be displayed.
DisplayOrder	Integer	False		No	The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False		No	Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False		No	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False		No	Boolean indicating if the property is calculated.
IsHidden	Boolean	False		No	Boolean indicating if the property is hidden.
IsFavorited	Boolean	False		No	Boolean indicating if the property is favorited.
FavoritedOrder	Integer	False		No	The favorited order for this property.
MutableDefinitionNotDeletable	Boolean	False		No	Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		No	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False		No	Boolean indicating if the value of the property is read only.
OptionsAggregate	String	False		No	An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True		No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
VID	Long	False	Contacts.VID	No	The unique id for the contact.
PropertyName	String	False		No	The name of the contact property.
Value	String	False		No	The historical value of the property.
Timestamp	Datetime	False		No	Datetime when the property was updated
SourceType	String	False		No	The method by which the property was changed
SourceId	String	False		No	Additional data realted to the source-type. May not be populated for all source-types.
SourceLabel	String	False		No	Additional data realted to the source-type. May not be populated for all source-types.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Name [KEY]	String	False	No	The name of the contact property group.
DisplayName	String	False	No	The display name of the contact group.
DisplayOrder	Integer	False	No	The numerical order of the contact group with respect to other contact groups.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
VID [KEY]	Long	True	No	The unique id for the contact.
ListId	Long	True	No	The list id the contact is a part of.
SearchTerms	String	True	No	An input only field representing potential searchterms you would like to specify when selecting contacts.
CanonicalVid	Long	True	No	The cannonical vid associated with the contact.
ProfileToken	String	True	No	A token for the profile of the contact.
ProfileUrl	String	True	No	A url to the profile of the contact.
IdentityProfilesAggregate	String	True	No	An aggregate of identities associated with this contact if any.
FormSubmissionsAggregate	String	True	No	An aggregate of forms submitted by this contact if any.
MergeAuditsAggregate	String	True	No	An aggregate of merged audits associated with this contact.
MergedVidsAggregate	String	True	No	An aggregate of merged vids associated with this contact.
OtherProperties	String	True	No	Other properties about the contact will dynamically obtained at runtime and will vary depending on the contact properties specific to your HubSpot HUB.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
VID [KEY]	Long	False	No	The unique id for the contact.
ListId [KEY]	Long	False	No	The list id the contact is a part of.
CanonicalVid	Long	True	No	The cannonical vid associated with the contact.
ProfileToken	String	True	No	A token for the profile of the contact.
ProfileUrl	String	True	No	A url to the profile of the contact.
IdentityProfilesAggregate	String	True	No	An aggregate of identities associated with this contact if any.
FormSubmissionsAggregate	String	True	No	An aggregate of forms submitted by this contact if any.
MergeAuditsAggregate	String	True	No	An aggregate of merged audits associated with this contact.
MergedVidsAggregate	String	True	No	An aggregate of merged vids associated with this contact.
OtherProperties	String	True	No	Other properties about the contact will dynamically obtained at runtime and will vary depending on the contact properties specific to your HubSpot HUB.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
LastNewContactAt	String	False		No	A datetime detailing when the last new contact was added.
Contacts	String	False		No	The total number of contacts.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Results	String	True	No	The IDs of objects associated with the given object, based on the specified association type.
FromObjectId [KEY]	Long	False	No	The ID of the object being associated.
ToObjectId [KEY]	Long	False	No	The ID of the object the from object is being associated with.
Category [KEY]	String	False	No	The category of the association. Currently this must be 'HUBSPOT_DEFINED'.
DefinitionId [KEY]	Long	False	No	The ID of the association definition.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
DealId [KEY]	Long	False	Deals.DealId	No	The Id of the deal.
AssociatedId [KEY]	Long	False		No	The Id of the associated entity.
AssociationType [KEY]	String	False		No	The type of association such as Company, or Contact.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
PipelineId [KEY]	String	True	No	The id of the pipeline.
PipelineName	String	False	No	The name of the pipeline.
IsActive	Boolean	False	No	A boolean indicating if the pipeline is active or not.
StagesAggregate	String	False	No	The stages in the pipeline.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
PipelineId [KEY]	String	True	DealPipelines.PipelineId	No	The id of the pipeline.
StageId [KEY]	String	True		No	The id of the stage.
PipelineName	String	False		No	The name of the pipeline.
PipelineIsActive	Boolean	False		No	A boolean indicating if the pipeline is active or not.
StageName	String	False		No	The name of the stage.
StageIsActive	Boolean	False		No	A boolean indicating if the stage is active or not.
StageClosedWon	Boolean	False		No	A boolean indicating if the stage indicates that the deal was closed and won.
StageDisplayOrder	Integer	False		No	The display order of the stage in the deal.
StageProbability	Double	False		No	The estimated probability of closing the deal at this stage.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Name [KEY]	String	False		No	The name of the contact property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False		No	The human readable label for the contact property that will display in the HubSpot UI.
FieldType	String	False		No	The type of field that will display on the screen for the company property.
Type	String	False		No	The stored machine type for the company property.
GroupName	String	False	DealPropertyGroups.Name	No	The group the company property is a part of.
Description	String	False		No	A description of what the property is for.
DisplayMode	String	False		No	How the property will be displayed.
DisplayOrder	Integer	False		No	The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False		No	Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False		No	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False		No	Boolean indicating if the property is calculated.
IsHidden	Boolean	False		No	Boolean indicating if the property is hidden.
IsDeleted	Boolean	True		No	Boolean indicating if the property has been deleted.
IsHubspotDefined	Boolean	True		No	Boolean indicating if the property is defined by HubSpot.
ShowCurrencySymbol	Boolean	False		No	Boolean indicating if the currency symbol should be shown. Only applicable for numbers.
MutableDefinitionNotDeletable	Boolean	False		No	Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		No	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False		No	Boolean indicating if the value of the property is read only.
OptionsUpdatable	Boolean	False		No	Boolean indicating if the options can be modified.
OptionsAggregate	String	False		No	An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True		No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
SourceId	String	False	No	Additional data realted to the source-type. May not be populated for all source-types.
SourceVid	String	False	No	A list of vids for related contacts. Only populated if related contacts caused the value to change.
PropertyName	String	False	No	The name of the deal property.
Value	String	False	No	The historical value of the property.
Timestamp	Datetime	False	No	Datetime when the property was updated
Source	String	False	No	The method by which the property was changed
DealId	Long	False	No	The Deal Id of the property.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Name [KEY]	String	False	No	The name of the contact property group.
DisplayName	String	False	No	The display name of the contact group.
DisplayOrder	Integer	False	No	The numerical order of the contact group with respect to other contact groups.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
DealId [KEY]	Long	True	No	The unique id for the deal.
DealName	String	True	No	The name of the deal.
IsDeleted	Boolean	True	No	A boolean indicating if the deal has been deleted.
AssociatedCompanyIds	String	True	No	A comma separated list of company ids associated with the deal.
AssociatedDealIds	String	True	No	A comma separated list of other deals associated with this deal.
AssociatedVids	String	True	No	A comma separated list of contact ids associated with this deal.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
DealId [KEY]	Long	False	Deals.DealId	No	The id of the deal.
StageCreated [KEY]	Datetime	False		No	When the deal stage was created.
StageName	String	False		No	The name of the deal stage.
StageValue	String	False		No	The value of the deal stage.
StageSource	String	False		No	The source of the deal stage.
StageSourceId	String	False		No	The source id of the deal stage.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The id of the domain.
CreatedAt	Datetime	True	No	When the domain was first created.
Domain	String	True	No	The actual domain or subdomain.
IsAnyPrimary	Boolean	True	No	True if this domain is primary for any category.
IsDNSCorrect	Boolean	True	No	True if DNS for this domain is optimally configured for use with HubSpot.
IsLegacyDomain	Boolean	True	No	True is this domain is setup for use with the classic CMS.
IsResolving	Boolean	True	No	True if this domain is pointing to HubSpot servers.
ManuallyMarkedAsResolving	Boolean	True	No	True if a user manually marked this domain as resolving. This is needed when their is some unique setup or proxy server involved, and the COS can not automatically detect if the domain is properly resolving.
PrimaryBlogPost	Boolean	True	No	True if this domain is primary for COS blog posts.
PrimaryEmail	Boolean	True	No	True if this domain is primary for viewing emails as web page.
PrimaryLandingPage	Boolean	True	No	True if this domain is primary for COS landing pages.
PrimaryLegacyPage	Boolean	True	No	True if this domain is primary for the classic CMS.
PrimarySitePage	Boolean	True	No	True if this domain is primary for COS site pages.
SecondaryToDomain	String	True	No	The name of the domain that this domain redirects to. Only set for non-primary domains.
UpdatedAt	Datetime	True	No	When the domain was last updated.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	The Id of the email campaign event.
CampaignId	String	False	EmailCampaigns.Id	No	Campaign id of the email campaign associated with the event.
Type	String	False		No	The type of event.
RecipientEmail	String	False		No	Email address of the recipient associated with the event.
PortalId	Long	False		No	An ID referencing the HubSpot account that sent the email message. This will correspond to your account.
AppId	Long	False		No	An Id referencing the HubSpot Application which sent the email message.
AppName	String	False		No	The name of the HubSpot Application which sent the email message. Note that this is a derived value, and may be modified at any time.
CreatedAt	Datetime	False		No	When this event was created.
SentById	String	False		No	The Event Id which uniquely identifies the email message's SENT event.
SentByCreatedAt	Datetime	False		No	When the email message's SENT event. wich created.
ObsoletedById	String	False		No	The EventId which uniquely identifies the follow-on event which makes this current event obsolete.
ObsoletedByCreatedAt	Datetime	False		No	When the event which obsoleted the current event was created.
CausedById	String	False		No	The EventId which uniquely identifies the event which directly caused this event.
CausedByCreatedAt	Datetime	False		No	When the event which caused the current event was created.
Subject	String	False		No	The subject line of the email message.
From	String	False		No	The 'from' field of the email message.
ReplyTo	String	False		No	The 'reply-to' field of the email message.
Cc	String	False		No	The 'cc' field of the email message.
Bcc	String	False		No	The 'bcc' field of the email message.
DropReason	String	False		No	The reason why the email message was dropped.
DropMessage	String	False		No	The raw message describing why the email message was dropped. This will usually provide additional details beyond 'dropReason'.
Category	String	False		No	The best-guess of the type of bounce encountered. If an appropriate category couldn't be determined, this property is omitted.
Response	String	False		No	The full response from the recipient's email server.
SmtpId	String	False		No	An ID attached to the message by HubSpot.
Attempt	Integer	False		No	The delivery attempt number.
Status	String	False		No	The status code returned from the recipient's email server.
DeviceType	String	False		No	The type of device used that triggered the event if avialable.
HMID	String	False		No	A randomly-generated Id which corresponds to the header 'X-HubSpot-MID' in the email message.
Referer	String	False		No	The URL of the webpage that linked to the URL clicked. Whether this is provided, and what its value is, is determined by the recipient's email client.
Url	String	False		No	The URL within the message that the recipient clicked.
UserAgent	String	False		No	The user agent responsible for the event.
BrowserFamily	String	False		No	The family of the browser that serviced the event.
BrowserName	String	False		No	The name of browser that serviced the event.
BrowserProducer	String	False		No	The producer of browser that serviced the event.
BrowserProducerUrl	String	False		No	A url to the producer of the browser if available.
BrowserType	String	False		No	The type of browser that produced the event.
BrowserUrl	String	False		No	A url to an entry describing the browser if available.
BrowserVersion	String	False		No	The versionof browser used.
LocationCity	String	False		No	The city where the event occurred.
LocationCountry	String	False		No	The country where the event occurred.
LocationState	String	False		No	The state where the event occurred.
FilteredEvent	Boolean	False		No	A boolean representing whether the event has been filtered out of reporting based on customer reports settings or not.
Source	String	False		No	The source of the subscription change.
RequestedBy	String	False		No	The email address of the person requesting the change on behalf of the recipient.
Subscriptions	String	False		No	The status of subscriptions for the recipient.
PortalSubscriptionStatus	String	False		No	The recipient's portal subscription status.
ExtraUrlParameters	String	True		No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	The Id of the email campaign.
AppName	String	False	No	The name of the app associated with the email campaign.
AppId	Long	True	No	The Id of the app associated with the email campaign.
LastUpdatedTime	Datetime	True	No	When the email campaign was lasted updated.
Name	String	True	No	The name of the campaign.
ContentId	Long	True	No	The ContentId of the email campaign.
NumberBounced	Long	True	No	The number bounced.
NumberClick	Long	True	No	The number of clicks.
NumberDeferred	Long	True	No	The number deferred.
NumberDelivered	Long	True	No	The number delivered.
NumberDropped	Long	True	No	The number dropped.
NumberIncluded	Long	True	No	The number included.
NumberMTADropped	Long	True	No	The number mta dropped.
NumberOpen	Long	True	No	The number open.
NumberProcessed	Long	True	No	The number processed.
NumberQueued	Long	True	No	The number queued.
NumberSent	Long	True	No	The number sent.
NumberStatusChanged	Long	True	No	The number where the status was changed.
NumberUnsubscribed	Long	True	No	The number unsubscribed.
ProcessingState	String	True	No	The processing state of the email campaign.
Type	String	True	No	The type of email campaign.
SubType	String	True	No	The subtype of the email campaign.
Subject	String	True	No	The subject of the email campaign.
LastProcessingStartedAt	Datetime	True	No	Last date the email campaign last began processing at.
LastProcessingFinishedAt	Datetime	True	No	When the email campaign last finished processing at.
LastProcessingStateChangeAt	Datetime	True	No	The last time the email campaign's processing state changed.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Email [KEY]	String	True	No	The email address which has been subscribed.
SubscriptionId [KEY]	Long	True	No	The id of the subscription type.
IsSubscribed	Boolean	False	No	Boolean indicating if the customer is subscribed.
ExtraUrlParameters	String	False	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.
LegalBasis	String	False	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.
LegalBasisExplanation	String	False	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.
OptState	String	False	No	Determines whether a contact is opted in or out of a given email subscription. If you OPT OUT of all emails or a specific email subscription type for a recipient, there is NO UNDO for this operation. The possible values are OPT_IN, OPT_OUT, and NOT_OPTED.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The Id of the email subscription type.
Name	String	False	No	The name of the email subscription type.
IsActive	Boolean	True	No	Whether or not the email subscription type is active.
Description	String	False	No	A description for the email subscription type.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The id of the engagement.
PortalId	Long	True	No	The portal id the engagement is associated with.
IsActive	Boolean	True	No	Boolean indicating if the engagement is active or not.
CreatedAt	Datetime	True	No	When the engagement was created.
UpdatedAt	Datetime	True	No	When the engagement was last updated.
CreatedBy	Long	True	No	User id of the user who created the engagement.
ModifiedBy	Long	True	No	User id of the user who lastmodified the engagement.
OwnerId	Long	False	No	The owner id of the engagement.
Type	String	False	No	The type of engagement. Required on inserts.
ActivityType	String	False	No	The activity type of engagement.
DateTime	Datetime	False	No	A custom datetime that can be specified when inserting the engagement. This can be used for keeping track of something related to the engagement such as when a call was made.
AssociatedContacts	String	False	No	A comma separated list of contact ids associated with the engagement.
AssociatedCompanies	String	False	No	A comma separated list of company ids associated with the engagement.
AssociatedDeals	String	False	No	A comma separated list of deal ids associated with the engagement.
AssociatedOwners	String	True	No	A comma separated list of owner ids associated with the engagement.
AssociatedWorkflows	String	False	No	A comma separated list of workflow ids associated with the engagement.
AssociatedTickets	String	False	No	A comma separated list of ticket ids associated with the engagement.
Attachments	String	False	No	The attachments associated with this engagement.
MessageId	String	False	No	The messageId of an engagement.
ThreadId	String	False	No	The threadId of an engagement.
Body	String	False	No	The body of an engagement. Only used when Type = NOTE, TASK, PUBLISHING_TASK, CALL, or MEETING.
Status	String	False	No	The status of the task. Only used when Type = TASK, CALL, MEETING.
ForObjectType	String	False	No	The object type the task is for. For instance, CONTACT. Only used when Type = TASK.
StartTime	String	False	No	The start date time for the meeting. Only used when Type = MEETING.
EndTime	String	False	No	The end date time for the meeting. Only used when Type = MEETING.
Title	String	False	No	The title of the meeting. Only used when Type = MEETING.
FromEmail	String	False	No	The from email in the engagement. Only used when Type = EMAIL.
FromFirstName	String	False	No	The first name the email was from in the engagement. Only used when Type = EMAIL.
FromLastName	String	False	No	The last name the email was from in the engagement. Only used when Type = EMAIL.
ToEmail	String	False	No	A comma separated list of emails the message was sent to. Only used when Type = EMAIL.
Cc	String	False	No	A comma separated list of cc'd email addresses. Only used when Type = EMAIL.
Bcc	String	False	No	A comma separated list of bcc'd email addresses. Only used when Type = EMAIL.
Subject	String	False	No	The subject of the email. Only used when Type = EMAIL.
EmailHtml	String	False	No	Html content consisting of the body of the email. Only used when Type = EMAIL.
EmailText	String	False	No	Plain text content consisting of the body of the email. Only used when Type = EMAIL.
CampaignGuid	String	False	No	The campaign guid of an engagement. Only used when Type = PUBLISHING_TASK.
Category	String	False	No	The category of the engagement. Used when Type = PUBLISHING_TASK.
CategoryId	Integer	False	No	The category id of the engagement. Used when Type = PUBLISHING_TASK.
ContentId	String	False	No	The content id of the engagement. Used when Type = PUBLISHING_TASK.
State	String	False	No	The state of the engagement. Used when Type = PUBLISHING_TASK.
Name	String	False	No	The name of the engagement. Used when Type = PUBLISHING_TASK.
ToNumber	String	False	No	The phone number that was called. Used when Type = CALL.
FromNumber	String	False	No	The phone number that was used as the from number. Used when Type = CALL.
ExternalId	String	False	No	For calls made in HubSpot, this will be the internal ID of the call. Used when Type = CALL.
DurationMilliseconds	Long	False	No	The duration of the call in milliseconds. Used when Type = CALL.
ExternalAccountId	String	False	No	For calls made in HubSpot, this will be the internal ID of the account used to make the call. Used when Type = CALL.
RecordingUrl	String	False	No	The URL of the recording file . Used when Type = CALL.
Disposition	String	False	No	Internal GUID that corresponds to the Call Outcome. Used when Type = CALL.
MeetingOutcome	String	False	No	Meeting outcome. Used when TYPE = MEETING. The allowed values are: SCHEDULED, COMPLETED, RESCHEDULED, NO SHOW, CANCELED.
TaskType	String	False	No	Task type. Used when TYPE = TASK. The allowed values are: TODO, EMAIL, CALL.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
EngagementId	Long	False	No	The id of the engagement.
UUID	String	False	No	The scheduled task's uniqe Id.
PortalId	Long	False	No	The portal id the engagement is associated with.
EngagementType	String	False	No	The type of engagement.
TaskType	String	False	No	The type of the scheduled task.
Timestamp	Datetime	False	No	Time when the task was scheduled.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
EngagementId	Long	False	No	The id of the engagement.
UUID	String	False	No	The scheduled task's uniqe Id.
PortalId	Integer	False	No	The portal id the engagement is associated with.
EngagementType	String	False	No	The type of engagement.
TaskType	String	False	No	The type of the scheduled task.
Timestamp	Datetime	False	No	Time when the task was scheduled.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The id of the contact.
WorkflowId [KEY]	Long	True	No	The id of the workflow.
PortalId	String	True	No	Portal id for enrollment.
Name	String	True	No	Represents the name or title associated with the specified workflow.
Description	String	True	No	Represents the description associated with the specified workflow.
AllowContactToTriggerMultipleTimes	Bool	True	No	Represents whether a contact is allowed to trigger the specified workflow multiple times.
AllowEnrollmentFromMerge	Bool	True	No	Indicates if the merging of contacts triggers enrollment. If true, enrollment is enabled when contacts are merged.
EnrollOnCriteriaUpdate	Bool	True	No	Specifies if updates to enrollment criteria trigger enrollment. If true, enrollment is enabled when enrollment criteria are updated.
CanEnrollFromSalesforce	Bool	True	No	A setting indicating whether the workflow is available to be seen from the HubSpot embed in Salesforce.
Listening	Bool	True	No	Whether contacts should be unenrolled from the workflow if they are no longer a member of any of the lists used as starting conditions.
Enabled	Bool	True	No	Represents whether the specified workflow enrollment is currently enabled or disabled.
Author	String	True	No	Include details about the user or account responsible for designing and implementing the workflow within the HubSpot platform.
AuthorUserId	Long	True	No	Indicates the unique identifier of the account responsible for creating the workflow.
Type	String	True	No	Indicate the type or category of the workflow.
IsSegmentBased	Bool	True	No	Represents whether the workflow is segment-based.
InsertedAt	Datetime	True	No	Indicates the date and time when the contact was inserted or enrolled into the specified workflow.
UpdatedAt	Datetime	True	No	Indicates the date and time when the contact was updated or enrolled into the specified workflow.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	The unique id for the event.
Name	String	False	No	The name of the evemt.
Label	String	False	No	The label of the evemt.
Status	String	False	No	The status of the evemt.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	The unique id of the file.
Name	String	True		No	The internal name of the file.
FriendlyUrl	String	True		No	A full url to the file that can be used from a web browser to view or download the file.
AltKey	String	True		No	An alternative file key. This is used for creationg the 'alt_url', which is a url for the file that does not include the file id. This is useful if you need to upload a collection of files where their relative location needs to preserved.
AltUrl	String	True		No	The alternative file URL, without the auto-generated file id in it. This is generated by concatenating the alt_key to the base CDN url.
IsArchived	Boolean	True		No	If True, the file will not show up in your dashboard, although the file will still be live.
CreatedAt	Datetime	True		No	When the file was first created.
DeletedAt	Datetime	True		No	When the file was deleted.
Extension	String	True		No	The extension of the file.
FolderId	Long	True	Folders.Id	No	The id of the folder this file is in.
RSUploadedAt	Datetime	True		No	When the file was uploaded via RS.
S3UploadedAt	Datetime	True		No	When the file was uploaded via S3.
Size	Long	True		No	The size in bytes of the file.
IsSynced	Boolean	True		No	A boolean indicating if this is a CTA image.
Title	String	True		No	The title of the file.
Type	String	True		No	A string enum for type of the file.
UpdatedAt	Datetime	True		No	When the file was last updated.
Version	Double	True		No	The version of the file.
Height	Integer	True		No	For images only, the height in pixels of the image.
Width	Integer	True		No	For images only, the width in pixels of the image.
ExtraUrlParameters	String	True		No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	The id of the folder.
Category	Integer	True		No	The category of the folder.
CreatedAt	Datetime	True		No	When the folder was created.
DeletedAt	Datetime	True		No	When the folder was deleted.
FullPath	String	True		No	The full path to the folder.
Name	String	True		No	The name of the folder.
ParentFolderId	Long	True	Folders.Id	No	The id of the parent folder for this folder if available.
UpdatedAt	Datetime	True		No	When the folder was last updated.
ExtraUrlParameters	String	True		No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
FormGUID	String	True	No	The unique key for the form.
Name	String	True	No	The name of the field.
DefaultValue	String	True	No	The default value of the field.
Required	Boolean	True	No	Boolean indicating wether the field is required in the form.
Enabled	Boolean	True	No	Boolean indicating wether the field is enabled.
IsSmartField	Boolean	True	No	Boolean indicating wether this is a smart field.
Label	String	True	No	Label of the field.
GroupName	String	True	No	Name of the group the field belongs to.
SelectedOptions	String	True	No	The selected options for the field.
FieldType	String	True	No	Type of the field.
Hidden	Boolean	True	No	Boolean indicating wether the field is hidden.
Validation	String	True	No
Type	String	True	No	Value type of the field.
Options	String	True	No	Field options
DisplayOrder	Int	True	No	Display order of the field

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
GUID [KEY]	String	True	No	The unique key for the form.
Name	String	False	No	The name of the form.
Action	String	False	No	An action to execute when the form is submitted.
CSSClass	String	False	No	The CSS class associated with the form.
IsDeletable	Boolean	False	No	A boolean indicating if the form is deletable.
EmbeddedCode	String	False	No	Embedded javascript code included with the form.
FollowUpId	String	False	No	An Id to follow up with if available.
IgnoreCurrentValues	Boolean	False	No	A boolean indicating if current or default values should be ignored when submitting the form.
Method	String	False	No	The HTTP method to use when submitting the form.
MigratedFrom	String	True	No	Information about where the form was migrated from if available.
NotifyRecipients	String	False	No	Email address of recipients that should notified when the form is submitted.
PerformableHTML	String	False	No	HTML that should be performed on the form.
Redirect	String	False	No	A url to redirect the user to once the form has been submitted.
SubmitText	String	False	No	The submit button text.
CreatedAt	Datetime	True	No	When the form was created.
UpdatedAt	Datetime	True	No	When the form was last updated.
FormFieldGroupsAggregate	String	False	No	A collection of the groups of fields available in the form.
SelectedExternalOptionsAggregate	String	False	No	The selected external options for the form. This includes the default lifecycle stage which categorizes your contacts and companies while providing context about where they are in your sales and marketing processes.
MetaDataAggregate	String	True	No	A collection of metadata about the form.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
FormGUID	String	True	No	The unique key for the form.
PageUrl	String	True	No	Url of the page.
SubmittedAt	Datetime	True	No	Submitted time.
Name	String	True	No	Name of the submission.
Value	String	True	No	Value of the submission.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Name [KEY]	String	False	No	The name of the ticket property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False	No	The human readable label for the ticket property that will display in the HubSpot UI.
FieldType	String	False	No	The type of field that will display on the screen for the company property.
Type	String	False	No	The stored machine type for the company property.
GroupName	String	False	No	The group the company property is a part of.
Description	String	False	No	A description of what the property is for.
DisplayMode	String	False	No	How the property will be displayed.
DisplayOrder	Integer	False	No	The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False	No	Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False	No	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False	No	Boolean indicating if the property is calculated.
IsHidden	Boolean	False	No	Boolean indicating if the property is hidden.
IsFavorited	Boolean	False	No	Boolean indicating if the property is favorited.
FavoritedOrder	Integer	False	No	The favorited order for this property.
MutableDefinitionNotDeletable	Boolean	False	No	Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False	No	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False	No	Boolean indicating if the value of the property is read only.
OptionsAggregate	String	False	No	An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The internal ID for this line item.
Name	String	False	No	The name for the product for this line item.
Price	String	False	No	The price of the line item.
Quantity	String	False	No	The quantity of the line item.
Description	String	False	No	The description of the line item.
ProductId	String	False	No	The objectId of a product object, and represents the product being sold. It is required when you create a new line item.
Version	Integer	True	No	The current version of this line item. This is incremented each time the line item is updated.
IsDeleted	Boolean	True	No	Boolean indicating whether or not the line item is deleted. Deleted records will not be included unless you specifically request that deleted records be included.
IncludeDeleted	String	False	Yes	By default, deleted records will not be returned by the API. When selecting by Id, you can include this parameter to make sure that records are returned even when they are deleted

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The id of the email.
RssToEmailTimingRepeats	String	False	No	[ 'instant', 'daily', 'weekly', 'monthly' ]
RssToEmailTimingRepeatsOnMonthly	Integer	False	No	What day of the month should the monthly email be sent [1-31].
RssToEmailTimingRepeatsOnWeekly	Integer	False	No	What day of the week should the weekly email be sent [1=monday - 7=sunday].
RssToEmailTimingSummary	String	False	No	Descripton. Not used.
RssToEmailTimingTime	String	False	No	Time the email should be sent at.
Ab	Boolean	True	No	Whether or not the page is part of an AB test.
AbHoursToWait	Integer	False	No	On AB emails, if test results are inconclusive after the specified hours, variation A will be sent.
AbSampleSizeDefault	String	True	No	['MASTER', 'VARIANT'] if there are less than 1000 recipients, only one variation will be sent.
AbSamplingDefault	String	False	No	['MASTER', 'VARIANT'] if AB test results are inconclusive in the test group, choose a variation to send (resp. A or B) to the remaining contacts.
AbStatus	String	False	No	['MASTER', 'VARIANT'] determines if the current email is variation A or variation B.
AbSuccessMetric	String	False	No	[ CLICKS_BY_OPENS, CLICKS_BY_DELIVERED, OPENS_BY_DELIVERED ] metric that will be used to determine the winning variation.
AbTestId	String	False	No	ID shared between variation A and B
AbTestPercentage	Integer	False	No	The size of the test group.
AbVariation	Boolean	False	No	Determines whether the email is a variant or not.
AbsoluteUrl	String	False	No	The URL of the web version of the email.
AllEmailCampaignIds	String	False	No	A list of email IDs that are associated with the email.
AnalyticsPageId	String	False	No	The ID used to access the analytics page of the email.
AnalyticsPageType	String	True	No	Always 'email' for an email.
Archived	Boolean	False	No	Determines whether the email is archived or not.
Author	String	True	No	The email of the user who made the last update to the email.
AuthorAt	Datetime	True	No	Timestamp of the last update to the email in milliseconds.
AuthorEmail	String	True	No	The email of the user who made the last update to the email.
AuthorName	String	True	No	The name of the user who made the last update to the email.
AuthorUserId	Long	True	No	ID of the user who made the last update to the email.
BlogEmailType	String	False	No	['instant', 'daily', 'weekly', 'monthly'] the cadence for how often blog emails should be sent.
Campaign	String	False	No	The ID of an email's marketing campaign.
CampaignName	String	False	No	The name of the email's marketing campaign.
CanSpamSettingsId	Long	False	No	ID used to retrieve the company address, shown in the footer.
CategoryId	Integer	True	No	The category ID value, which is always 2 for emails (read only).
ClonedFrom	Long	True	No	If the email was cloned, ID of the email it was cloned from.
ContentTypeCategory	Integer	True	No	The category ID value, which is always 2 for emails (read only).
CreatePage	Boolean	False	No	Enables a web version of the email when set to true.
Created	Datetime	True	No	The timestamp of the email's creation, in milliseconds.
CurrentlyPublished	Boolean	False	No	Determines the publish status of the email.
Domain	String	True	No	The domain of the web version of the email. Defaults to the primary domain.
EmailBody	String	False	No	The main content of the email within the 'main email body' module.
EmailNote	String	False	No	Optional email notes, included in the details page of the email.
EmailType	String	False	No	Type of the email.
FeedbackEmailCategory	String	False	No	[ 'NPS', 'CES', 'CUSTOM' ] If the email is a feedback email, determines type of feedback email.
FeedbackSurveyId	Long	False	No	The id of the feedback survey that is linked to the email.
FolderId	Long	False	No	If the email is in a folder, id of that folder.
FreezeDate	Datetime	False	No	The publish date or updated date if the email is not published.
FromName	String	False	No	The sender name recipients will see (linked to the replyTo address).
HtmlTitle	String	False	No	The page title of the web version of the email.
IsGraymailSuppressionEnabled	Boolean	False	No	If true, the email will not send to unengaged contacts.
IsLocalTimezoneSend	Boolean	False	No	If true, the email will adjust its send time relative to the recipients timezone.
IsPublished	Boolean	False	No	If true, the email is in a published state.
LiveDomain	String	True	No	Domain actually used in the web version (read only)
MailingListsExcluded	String	True	No	A list of all contact lists to exclude from the email send.
MailingListsIncluded	String	True	No	A list of all contact lists included in the email send.
MaxRssEntries	Long	False	No	In blog and recurring emails, the max number of entries to include.
MetaDescription	String	False	No	Meta description of the web version of the email, to drive search engine traffic to your page
Name	String	False	No	The name of the email, as displayed on the email dashboard.
PageExpiryDate	Datetime	False	No	The expiration date of the web version of an email, in milliseconds.
PageExpiryRedirectId	Long	False	No	The url of the page the user will be redirected to after the web version of the email expires.
PageRedirected	Boolean	False	No	Indicates if the email's web version has already been set to redirect
PortalId	Long	False	No	The id of the parent portal.
PreviewKey	String	False	No	The preview key used to generate the preview url before the email is published
ProcessingStatus	String	False	No	The email's processing status.
PublishDate	Datetime	False	No	The timestamp in milliseconds that the email has been published at, or scheduled to send at.
PublishImmediately	Boolean	False	No	True if the email is not scheduled but will send at publish time.
PublishedAt	Datetime	True	No	If the email has been published, the time when the publish button has been pressed.
PublishedById	Long	True	No	If the email has been published, email of the user that pressed the publish button.
PublishedByName	String	True	No	If the email has been published, name of the user that pressed the publish button.
PublishedUrl	String	True	No	AbsoluteUrl, only if the email is currentlyPublished
ReplyTo	String	False	No	The email address the recipient will see and reply to.
ResolvedDomain	String	True	No	The domain used in the web version: either the primary one or the one set in the domain field.
RssEmailAuthorLineTemplate	String	False	No	Text shown before the 'author_line' tag in blog and RSS email's items.
RssEmailBlogImageMaxWidth	Integer	False	No	The max width for blog post images in RSS emails.
RssEmailByText	String	False	No	If rssEmailAuthorLineTemplate is not set, word before the author name in blog and RSS email's items.
RssEmailClickThroughText	String	False	No	Text shown on the link to see the full post in blog and RSS email's items.
RssEmailCommentText	String	False	No	Text shown on the link to comment the post in blog and RSS email's items.
RssEmailEntryTemplate	String	False	No	Optional, custom template for every RSS entry.
RssEmailEntryTemplateEnabled	Boolean	False	No	Determines if the Entry Template is used for an RSS email.
RssEmailUrl	String	False	No	URL used for social sharing.
Slug	String	False	No	Path of the web version URL.
Subcategory	String	False	No	Subcategory.
Subject	String	False	No	The subject of the email.
Subscription	Long	False	No	The id of the email's subscription type.
SubscriptionBlogId	Long	False	No	For blog emails, id of the linked blog.
SubscriptionName	String	False	No	The name of the email's subscription type.
TemplatePath	String	False	No	The path of the email's body template within the design manager.
Transactional	Boolean	True	No	Determines whether the email is a transactional email or not.
UnpublishedAt	Datetime	False	No	The timestamp in milliseconds of when the email was unpublished.
Updated	Datetime	True	No	Timestamp of the last update in milliseconds.
UpdatedById	Long	True	No	The ID of the last user who updated the email.
Url	String	True	No	The web version URL
UseRssHeadlineAsSubject	Boolean	False	No	Setting for RSS emails, uses the latest RSS entry as the email subject.
Widgets	String	True	No	The content of layout sections of the email (widgets).
VidsExcluded	String	True	No	A list of contact IDs to exclude from being sent the email.
VidsIncluded	String	True	No	A list of contacts IDs to include in the email send.
WorkflowNames	String	True	No	A list of all linked workflows to this email.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	The id of the page.
ArchivedInDashboard	Boolean	True		No	If True, the page will not show up in your dashboard, although the page will still be live.
CampaignId	String	True	EmailCampaigns.Id	No	The guid of the marketing campaign this page is associated with.
CampaignName	String	True	EmailCampaigns.Name	No	The name of the marketing campaign this page is associated with.
CreatedAt	Datetime	True		No	When the page was created.
CurrentLiveDomain	String	True		No	The domain this page is currently located on.
ArchivedAt	Datetime	True		No	When the page was deleted
FooterHTML	String	True		No	Custom HTML for embed codes, javascript that should be placed before the body tag of the page
HeaderHTML	String	True		No	Custom HTML for embed codes, javascript, etc. that goes in the head tag of the page
IsDraft	Boolean	True		No	True if the post is still a draft, invisible to the public. Gets changed when the /publish-action API endpoint is called.
MetaDescription	String	True		No	A description that goes in meta tag on the page
MetaKeywords	String	True		No	Keywords for the meta tag.
Name	String	True		No	The internal name of the page.
Password	String	True		No	Set this to create a password protected page. Entering the password will be required to view the page.
PublishDate	Datetime	True		No	The date the page is to be published at in milliseconds since the unix epoch.
Slug	String	True		No	The path of the URL on which the page will live. Changing this will change the URL.
StyleOverrideId	String	True		No	The ID of the style to use for this page, set this to use a different style than the default style for the site.
Subcategory	String	True		No	This is set to empty or to
UpdatedAt	Datetime	True		No	When the page was last updated.
Url	String	True		No	The full URL with domain and scheme to the page. Will return a 404 if the page is not yet published.
ExtraUrlParameters	String	True		No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Name [KEY]	String	False	No	The name of the ticket property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False	No	The human readable label for the ticket property that will display in the HubSpot UI.
FieldType	String	False	No	The type of field that will display on the screen for the company property.
Type	String	False	No	The stored machine type for the company property.
GroupName	String	False	No	The group the company property is a part of.
Description	String	False	No	A description of what the property is for.
DisplayMode	String	False	No	How the property will be displayed.
DisplayOrder	Integer	False	No	The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False	No	Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False	No	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False	No	Boolean indicating if the property is calculated.
IsHidden	Boolean	False	No	Boolean indicating if the property is hidden.
IsFavorited	Boolean	False	No	Boolean indicating if the property is favorited.
FavoritedOrder	Integer	False	No	The favorited order for this property.
MutableDefinitionNotDeletable	Boolean	False	No	Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False	No	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False	No	Boolean indicating if the value of the property is read only.
OptionsAggregate	String	False	No	An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The internal ID for this product.
Name	String	False	No	The name of the product.
Sku	String	False	No	The SKU of the product.
Price	String	False	No	The price of the product.
Description	String	False	No	The description of the product.
Version	Integer	True	No	The current version of the product. This is incremented each time the product is updated.
IsDeleted	Boolean	False	No	Boolean indicating whether or not the product is deleted. Deleted records will not be included unless you specifically request that deleted records be included.
IncludeDeleted	String	False	Yes	By default, deleted records will not be returned by the API. When selecting by Id, you can include this parameter to make sure that records are returned even when they are deleted

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
ChannelGUID [KEY]	String	True	No	The social media channel GUID.
AccountGUID	String	False	No	The account GUID associated with the social media channel.
AccountSlug	String	False	No	The account slug.
AccountType	String	False	No	The type of account.
IsActive	Boolean	False	No	A boolean indicating if the channel is active.
AutoPublish	Boolean	False	No	A boolean indicating if messages should be automatically published to the channel.
AvatarUrl	String	False	No	A url to the avatar for your account on the social medial channel.
ChannelId	String	False	No	The id for the channel on the social media site.
ChannelKey	String	False	No	A HubSpot key associated with the channel.
ChannelSlug	String	False	No	The slug associated with the channel.
CreatedAt	Datetime	True	No	When the channel was created.
FollowMe	Boolean	False	No	A boolean indicating if the channel should be followed.
IsHidden	Boolean	False	No	A boolean indicating if the channel is hidden.
Monitoring	Boolean	False	No	A boolean indicating if the channel should be monitored.
Reach	Boolean	False	No	A boolean indicating if tracking the growth of followers on this account over time should be enabled.
ReachType	String	False	No	The type of reach for this social media channel.
IsShared	Boolean	False	No	A boolean indicating if this social media channel is shared.
Type	String	False	No	The type of social media channel.
UpdatedAt	Datetime	True	No	When this social media channel was last updated.
UserName	String	False	No	The user name for the social media channel.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
MessageGUID [KEY]	String	True	No	The Id of the social media message.
ContentBody	String	False	No	The body of the content for the message.
ContentOriginalBody	String	False	No	The original body of the content for the message if it has been altered.
ContentPhotoUrl	String	False	No	The photo associatedwith the message.
ContentUncompressedLinks	String	False	No	Any uncompressed links associated with the message.
TriggerAt	Datetime	False	No	When to trigger the social media message.
Channel	String	True	No	The social media channel the message will be posted to.
ChannelGUID	String	False	No	The social media channel GUID.
CampaignGUID	String	True	No	The campaign GUID associated with the social media message.
CampaignName	String	True	No	The campaign name associated with the social media message.
Clicks	Long	True	No	The number of clicks HubSpot has recorded for the links in the social media message.
ClientTag	String	True	No	Client tags associated with the social media message.
CreatedAt	Datetime	True	No	When the social media message was created.
CreatedBy	Long	True	No	An integer indicating which user created the social mdia message.
FinishedAt	Datetime	True	No	When the social media message was finished posting.
ForeignId	String	True	No	An optional ForeignId associated with the social media message.
GroupGUID	String	True	No	The group GUID associated with the social media message.
IsFailed	Boolean	True	No	A boolean indicating if the message has failed to post.
IsPending	Boolean	True	No	A boolean indicating if the message is pending a post.
IsPublished	Boolean	True	No	A boolean indicating if the message has been posted.
IsRetry	Boolean	True	No	A boolean indicating if the message is being retried.
Message	String	True	No	The message that came back from the social media site if any. This may contain an error message if the social media message failed if the status is ERROR_FATAL.
MessageUrl	String	True	No	A url associated with the message that came back from the social media site. This may simply be a link to the social media posting if the status is SUCCESS.
RemoteContentId	String	True	No	A remote content id if any.
RemoteContentType	String	True	No	The remote content type if any.
Status	String	True	No	The current status of the social media message.
UpdatedBy	Long	True	No	An integer indicating who last updated the social media message.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The id of the template.
CategoryId	Long	True	No	The category of content this template can be used for. 1 for landing page, 2 for email, 3 for site page.
CDNMinifiedUrl	String	True	No	For javascript and css, this is the URL of the version of the content that has been rendered, minified, and uploaded to our Content Delivery Network.
CDNUrl	String	True	No	For non-html templates, the URL to the version of the template that has been rendered and uploaded to the HubSpot CDN.
DeletedAt	Datetime	True	No	When the template was deleted.
Folder	String	True	No	The folder this template lives in.
GeneratedFromLayoutId	String	True	No	The id of the layout that generated this template.
IsAvailableForNewContent	Boolean	True	No	True if this template will show up in the content creation screen.
IsFromLayout	Boolean	True	No	True if template was generated by publishing a layout.
IsReadOnly	Boolean	True	No	True if the template can only be read.
Label	String	True	No	The label of the template as it shows up in the template builder.
Path	String	True	No	The path of the template, as should be used for HubL include statements.
Source	String	True	No	The markup of the template.
ThumbnailPath	String	True	No	The thumbnail image of the template.
UpdatedAt	Datetime	True	No	When the template was last updated.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Name [KEY]	String	False	No	The name of the ticket property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False	No	The human readable label for the ticket property that will display in the HubSpot UI.
FieldType	String	False	No	The type of field that will display on the screen for the company property.
Type	String	False	No	The stored machine type for the company property.
GroupName	String	False	No	The group the company property is a part of.
Description	String	False	No	A description of what the property is for.
DisplayMode	String	False	No	How the property will be displayed.
DisplayOrder	Integer	False	No	The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False	No	Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False	No	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False	No	Boolean indicating if the property is calculated.
IsHidden	Boolean	False	No	Boolean indicating if the property is hidden.
IsFavorited	Boolean	False	No	Boolean indicating if the property is favorited.
FavoritedOrder	Integer	False	No	The favorited order for this property.
MutableDefinitionNotDeletable	Boolean	False	No	Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False	No	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False	No	Boolean indicating if the value of the property is read only.
OptionsAggregate	String	False	No	An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Name [KEY]	String	False	No	The name of the contact property group.
DisplayName	String	False	No	The display name of the contact group.
DisplayOrder	Integer	False	No	The numerical order of the contact group with respect to other contact groups.
IsHubspotDefined	Boolean	True	No	Indicator whether or not this field is defined in the Hubspot.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	The internal ID for this ticket.
PortalId	Long	False	No	The Portal or Hub ID that this object belongs to.
Version	Long	False	No	Version of the ticket.
IsDeleted	Boolean	False	No	Whether or not the ticket is deleted. Deleted records will not be included unless you specifically request that deleted records be included.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The id of the url mapping.
CreatedAt	Datetime	True	No	When the url mapping was created.
DeletedAt	Datetime	True	No	When the url mapping was deleted.
Destination	String	True	No	The URL to redirect to.
IsMatchFullUrl	Boolean	True	No	If true, the 'route_prefix' should match on the entire URL including the domain.
IsMatchQueryString	Boolean	True	No	If true, the 'route_prefix' should match on the entire URL path including the query string.
IsOnlyAfterNotFound	Boolean	True	No	If True, the URL mapping will only be applied if a live page matching the URL is not found. If False, the URL mapping will take precedence over any existing page.
Precedence	Integer	True	No	If a URL matches more than one mapping, the one with the lower precedence applies.
RoutePrefix	String	True	No	The incoming URL to match.
UpdatedAt	Datetime	True	No	When the url mapping was last updated.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The Id of the workflow.
Name	String	False	No	The name of the workflow.
Description	String	False	No	A description of the workflow.
IsEnabled	Boolean	False	No	A boolean indicating if this workflow is enabled.
CreatedAt	Datetime	True	No	When the workflow was created.
UpdatedAt	Datetime	True	No	When the workflow was last updated.
AllowContactToTriggerMultipleTimes	Boolean	False	No	A boolean indicating if the workflow can be triggered for the same contact multiple times.
CanEnrollFromSalesforce	Boolean	False	No	A boolean indicating if contacts can be enrolled to this workflow from Salesforce.
IsInternal	Boolean	False	No	A boolean indicating if the workflow is internal.
LegacyCampaignId	Long	False	No	The campaign id associated with the workflow if available.
LegacyMigration	Boolean	False	No	A boolean indicating if the workflow was migrated from the legacy lead nurturing tool.
IsListening	Boolean	False	No	A boolean indicating if the workflow is listening or active.
ContactListIdsCompleted	Long	True	No	ID of the completed contact list associated with the workflow.
ContactListIdsEnrolled	Long	True	No	ID of the enrolled contact list associated with the workflow.
ContactListIdsSucceeded	Long	True	No	ID of the contact list that successfully completed the workflow.
ContactListIdsActive	Long	True	No	ID of the active contact list associated with the workflow.
StepsAggregate	String	False	No	An aggregate of the steps to take when executing this workflow.
SupresssionSettingsAggregate	String	False	No	An aggregate of supression properties for this workflow.
TriggersAggregate	String	False	No	An aggregate of triggers for this workflow.
UnenrollmentSettingType	String	False	No	The type of unenrollment setting for this workflow.
UnenrollmentSettingExcludedWorkflowsAggregate	String	False	No	An workflows to exclude a contact from if they enroll in this workflow.
GoalListAggregate	String	False	No	An aggregate of goal ids for this workflow.
ExtraUrlParameters	String	True	No	An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Return to Top