forms_from_a_portal: WIP - Get all forms from a portal (raw and tidy)

In lockedata/hubspot: Work with Hubspot data

Description

For a given portal, return all forms that have been created in the portal. from the Get all forms from a portal endpoint.

Usage

hs_forms_from_a_portal_raw(
  token_path = hubspot_token_get(),
  apikey = hubspot_key_get(),
  all_form_types = FALSE
)

hs_forms_from_a_portal_tidy(
  forms_from_a_portal = hs_forms_from_a_portal_raw(),
  view = "forms"
)

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().
all_form_types	By default non-marketing forms are filtered out of this endpoint. To request all forms, use this paramter with the value of TRUE.
forms_from_a_portal	A forms_from_a_portal object, typically produced by running hs_forms_from_a_portal_raw()
view	A view (see Details)

Details

Required scope(s) for the OAuth token: forms.

Different view values and associated output.

• "forms": tibble of form IDs, names, createdAt dates, upatedAt date, type, published (T/F) and number of fields

• "fields": tibble of all forms as above with form fields (one field per row)

• "options": tibble of all forms and fields as above, with options for multiple option fields (one option per row)

Value

A list (hs_forms_from_a_portal_raw())

A tibble with associated entities (hs_forms_from_a_portal_tidy())

Examples

hs_forms_from_a_portal_raw()
forms <- hs_forms_from_a_portal_tidy()

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