get_contacts: Get a list of all contacts, including a set of properties

Description Usage Arguments Value

View source: R/contacts-deprecated.R

Description

Soon to be deprecated! Use hs_contacts_raw().

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
get_contacts(
  token_path = hubspot_token_get(),
  apikey = hubspot_key_get(),
  properties = hs_contact_properties_tidy(hs_contact_properties_raw(token_path =
    token_path, apikey = apikey)),
  property_history = "true",
  form_submission_mode = "newest",
  list_memberships = "false",
  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

form_submission_mode

Which form submissions should be fetched

list_memberships

Indicate whether current list memberships should be fetched

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 contact data


lockedata/hubspot documentation built on March 1, 2020, 8:54 p.m.