Navigation: Catalog: Deals > Schemas

Deals: HubSpot Deals

ListRead a page of deals. Control what is returned via the `properties` query param.

Catalog: Deals

Schema: Basic

Label: Deals

Retrieve: true

Insert: true

Update: false

Delete: false

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function Deals. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Default Value	Documentation
after		☐		The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
archived		☐		Whether to return only results that have been archived.

Columns of Table Function

The columns of the table function Deals are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.

Name	Data Type	Label	Required
archived	char	Archived	☐
archivedAt	datetime	Archived at	☐
associations	varchar2	Associations	☐
createdAt	datetime	Created at	☐
id	varchar2	ID	☐
prop_amount_in_home_currency	decimal	Amount in Company Currency	☐
prop_amount	decimal	Amount	☐
prop_closed_lost_reason	varchar2	Closed Lost Reason	☐
prop_closed_won_reason	varchar2	Closed Won Reason	☐
prop_closedate	datetime	Close Date	☐
prop_createdate	datetime	Created at	☐
prop_days_to_close	decimal	Days to Close	☐
prop_dealname	varchar2	Deal Name	☐
prop_dealstage	varchar2	Deal Stage	☐
prop_dealtype	varchar2	Deal Type	☐
prop_description	varchar2	Description	☐
prop_engagements_last_meeting_booked_campaign	varchar2	Last Meeting Booked Campaign	☐
prop_engagements_last_meeting_booked_medium	varchar2	Last Meeting Booked Medium	☐
prop_engagements_last_meeting_booked_source	varchar2	Last Meeting Booked Source	☐
prop_engagements_last_meeting_booked	datetime	Last Meeting Booked	☐
prop_hs_acv	decimal	Annual Contract Value	☐
prop_hs_all_accessible_team_ids	varchar2	All Accessible Team IDs	☐
prop_hs_all_collaborator_owner_ids	varchar2	All Collaborator Owner IDs	☐
prop_hs_all_owner_ids	varchar2	All Owner IDs	☐
prop_hs_all_team_ids	varchar2	All Team IDs	☐
prop_hs_analytics_latest_source_company	varchar2	Analytics Latest Source Company	☐
prop_hs_analytics_latest_source_contact	varchar2	Analytics Latest Source Contact	☐
prop_hs_analytics_latest_source_data_1_company	varchar2	Analytics Latest Source Data 1 Company	☐
prop_hs_analytics_latest_source_data_1_contact	varchar2	Analytics Latest Source Data 1 Contact	☐
prop_hs_analytics_latest_source_data_1	varchar2	Analytics Latest Source Data 1	☐
prop_hs_analytics_latest_source_data_2_company	varchar2	Analytics Latest Source Data 2 Company	☐
prop_hs_analytics_latest_source_data_2_contact	varchar2	Analytics Latest Source Data 2 Contact	☐
prop_hs_analytics_latest_source_data_2	varchar2	Analytics Latest Source Data 2	☐
prop_hs_analytics_latest_source_timestamp_company	datetime	Analytics Latest Source Timestamp Company	☐
prop_hs_analytics_latest_source_timestamp_contact	datetime	Analytics Latest Source Timestamp Contact	☐
prop_hs_analytics_latest_source_timestamp	datetime	Analytics Latest Source Timestamp	☐
prop_hs_analytics_latest_source	varchar2	Analytics Latest Source	☐
prop_hs_analytics_source_data_1	varchar2	Analytics Source Data 1	☐
prop_hs_analytics_source_data_2	varchar2	Analytics Source Data 2	☐
prop_hs_analytics_source	varchar2	Analytics Source	☐
prop_hs_arr	decimal	Annual Recurring Revenues	☐
prop_hs_attributed_team_ids	varchar2		☐
prop_hs_average_call_duration	decimal		☐
prop_hs_campaign	varchar2	Campaign	☐
prop_hs_closed_amount_in_home_currency	decimal	Closed Amount in Company Currency	☐
prop_hs_closed_amount	decimal	Closed Amount	☐
prop_hs_closed_deal_close_date	decimal		☐
prop_hs_closed_deal_create_date	decimal		☐
prop_hs_closed_won_count	decimal	Closed Won Count	☐
prop_hs_closed_won_date	datetime	Closed Won Date	☐
prop_hs_created_by_user_id	decimal	Created by User ID	☐
prop_hs_createdate	datetime	Created at	☐
prop_hs_cross_account_note	varchar2		☐
prop_hs_cross_sell_opportunity	char		☐
prop_hs_days_to_close_raw	decimal		☐
prop_hs_deal_amount_calculation_preference	varchar2	Deal Amount Calculation Preference	☐
prop_hs_deal_stage_probability_shadow	decimal	Deal Stage Probability Shadow	☐
prop_hs_deal_stage_probability	decimal	Deal Stage Probability	☐
prop_hs_exchange_rate	decimal	Exchange Rate	☐
prop_hs_forecast_amount	decimal	Forecast Amount	☐
prop_hs_forecast_probability	decimal	Forecast Probability	☐
prop_hs_has_empty_conditional_stage_properties	char		☐
prop_hs_has_last_conversation_follow_ups	char		☐
prop_hs_is_closed_count	decimal		☐
prop_hs_is_closed_lost	char		☐
prop_hs_is_closed_won	char	Is Closed Won	☐
prop_hs_is_closed	char	Is Closed	☐
prop_hs_is_in_first_deal_stage	char		☐
prop_hs_is_open_count	decimal		☐
prop_hs_last_conversation_with_followups_object_coordinates	varchar2		☐
prop_hs_last_gs_shared_message	datetime		☐
prop_hs_last_partner_shared_message_date	datetime		☐
prop_hs_last_shared_message_create_date	datetime		☐
prop_hs_lastmodifieddate	datetime	Last Modified Date	☐
prop_hs_latest_approval_status_approval_id	decimal		☐
prop_hs_latest_approval_status	varchar2		☐
prop_hs_latest_marketing_email_click_date	datetime		☐
prop_hs_latest_marketing_email_open_date	datetime		☐
prop_hs_latest_marketing_email_reply_date	datetime		☐
prop_hs_latest_meeting_activity	datetime	Latest Meeting Activity	☐
prop_hs_latest_sales_email_click_date	datetime		☐
prop_hs_latest_sales_email_open_date	datetime		☐
prop_hs_latest_sales_email_reply_date	datetime		☐
prop_hs_likelihood_to_close	decimal	Likelihood to Close	☐
prop_hs_line_item_global_term_hs_discount_percentage_enabled	char	Line Item Globel Term Discount Percentage Enabled	☐
prop_hs_line_item_global_term_hs_discount_percentage	varchar2	Line Item Globel Term Discount Percentage	☐
prop_hs_line_item_global_term_hs_recurring_billing_period_enabled	char	Line Item Global Term Recurring Billing Period Enabled	☐
prop_hs_line_item_global_term_hs_recurring_billing_period	varchar2	Line Item Global Term Recurring Billing Period	☐
prop_hs_line_item_global_term_hs_recurring_billing_start_date_enabled	char	Line Item Global Term Recurring Billing Start Date Enabled	☐
prop_hs_line_item_global_term_hs_recurring_billing_start_date	varchar2	Line Item Global Term Recurring Billing Start Date	☐
prop_hs_line_item_global_term_recurringbillingfrequency_enabled	char	Line Item Global Term Billing Frequency Enabled	☐
prop_hs_line_item_global_term_recurringbillingfrequency	varchar2	Line Item Global Term Billing Frequency	☐
prop_hs_manual_campaign_ids	decimal		☐
prop_hs_manual_forecast_category	varchar2	Manual Forecast Category	☐
prop_hs_merged_object_ids	varchar2	Merged Object IDs	☐
prop_hs_mrr	decimal	Monthly Recurring Revenues	☐
prop_hs_net_pipeline_impact	decimal		☐
prop_hs_next_meeting_id	decimal		☐
prop_hs_next_meeting_name	varchar2		☐
prop_hs_next_meeting_start_time	datetime		☐
prop_hs_next_step_updated_at	datetime		☐
prop_hs_next_step	varchar2	Next Step	☐
prop_hs_notes_last_activity	varchar2		☐
prop_hs_notes_next_activity_type	varchar2		☐
prop_hs_notes_next_activity	varchar2		☐
prop_hs_num_of_associated_line_items	decimal	Number of Associated Line Items	☐
prop_hs_num_target_accounts	decimal	Number of Target Accounts	☐
prop_hs_number_of_call_engagements	decimal		☐
prop_hs_number_of_inbound_calls	decimal		☐
prop_hs_number_of_outbound_calls	decimal		☐
prop_hs_number_of_overdue_tasks	decimal		☐
prop_hs_number_of_scheduled_meetings	decimal		☐
prop_hs_object_id	decimal	Object ID	☐
prop_hs_object_source_detail_1	varchar2		☐
prop_hs_object_source_detail_2	varchar2		☐
prop_hs_object_source_detail_3	varchar2		☐
prop_hs_object_source_id	varchar2		☐
prop_hs_object_source_label	varchar2		☐
prop_hs_object_source_user_id	decimal		☐
prop_hs_object_source	varchar2		☐
prop_hs_open_amount_in_home_currency	decimal		☐
prop_hs_open_deal_create_date	decimal		☐
prop_hs_owning_teams	varchar2		☐
prop_hs_pinned_engagement_id	decimal	Pinned Engagement ID	☐
prop_hs_predicted_amount_in_home_currency	decimal	Predicted Amount in Company Currency	☐
prop_hs_predicted_amount	decimal	Predicted Amount	☐
prop_hs_primary_associated_company	decimal		☐
prop_hs_primary_quote_data_updated_at	datetime		☐
prop_hs_priority	varchar2	Priority	☐
prop_hs_projected_amount_in_home_currency	decimal	Projected Amount in Company Currency	☐
prop_hs_projected_amount	decimal	Projected Amount	☐
prop_hs_read_only	char	Read-only	☐
prop_hs_sales_email_last_replied	datetime	Sales Email Last Replied	☐
prop_hs_source_object_id	decimal		☐
prop_hs_tcv	decimal	Total Contract Value	☐
prop_hs_unique_creation_key	varchar2	Unique Creation Key	☐
prop_hs_updated_by_user_id	decimal	Updated by User ID	☐
prop_hs_user_ids_of_all_notification_followers	varchar2	User IDs of All Notification Followers	☐
prop_hs_user_ids_of_all_notification_unfollowers	varchar2	User IDs of All Notification Unfollowers	☐
prop_hs_user_ids_of_all_owners	varchar2	User IDs of All Owners	☐
prop_hs_was_imported	char	Was Imported	☐
prop_hs_weighted_pipeline_in_company_currency	decimal		☐
prop_hubspot_owner_assigneddate	datetime	Owner Assigned Date	☐
prop_hubspot_owner_id	varchar2	Owner ID	☐
prop_hubspot_team_id	varchar2	Team ID	☐
prop_notes_last_contacted	datetime	Notes Last Contacted	☐
prop_notes_last_updated	datetime	Notes Last Updated	☐
prop_notes_next_activity_date	datetime	Notes Next Activity Date	☐
prop_num_associated_contacts	decimal	Number of Associated Contacts	☐
prop_num_contacted_notes	decimal	Number of Contacted Notes	☐
prop_num_notes	decimal	Number of Notes	☐
prop_pipeline	varchar2	Pipeline	☐
updatedAt	datetime	Updated at	☐

Please enable JavaScript to view this site.

HubSpot API Data Model

Deals: HubSpot Deals

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information