Soon to be deprecated! Use hs_deals_raw().

get_deals(
  token_path = hubspot_token_get(),
  apikey = hubspot_key_get(),
  properties = hs_deal_properties_tidy(hs_deal_properties_raw(token_path, apikey)),
  property_history = "true",
  associations = "true",
  max_iter = 10,
  max_properties = 100
)

Arguments

token_path

Path to OAuth 2.0 token. See hubspot_token_create().

apikey

API key to work with Hubspot (only used if token_path is NULL). See hubspot_key_set().

properties

Character vector of properties to request

property_history

Whether version history for properties should be returned

associations

Retrieve links to other entities

max_iter

The API is limited to a certain number of responses by page, use max_iter to limit how many pages of data will get returned

max_properties

Avoid URLs that are too long, limit the number of properties returned, if required.

Value

List with deals data