owners: Owners endpoint (raw and tidy)

Description Usage Arguments Details Value Examples

View source: R/owners-deprecated.R

Description

Retrieve raw and tidy results from the owners endpoint.

Usage

1
2
3
4
5
6
7
8
hs_owners_raw(
  token_path = hubspot_token_get(),
  apikey = hubspot_key_get(),
  include_inactive = TRUE,
  email = NULL
)

hs_owners_tidy(owners = hs_owners_raw(), view = c("owners"))

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().

include_inactive

Should inactive entities be returned

email

Search for owners matching the specified email address (exact match).

owners

Raw data from hs_owners_raw()

view

A view (see Details)

Details

Inactive owners are defined as owners without any active remotes.

Required scope(s) of the OAuth token: contacts.

Different view values and associated output.

Value

List of owners (hs_owners_raw())

A tibble of owners (hs_owners_tidy())

Examples

1
2
3
4
5
6
## Not run: 
owners <- hs_owners_raw()
active_owners <- hs_owners_raw(include_inactive = FALSE)
hs_owners_raw(email = "demo@hubspot.com")

## End(Not run)

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