AmoContacts: Contacts

In grkhr/amocrm: AmoCRM API client

Description

Function to get contacts.

Usage

AmoContacts(
  email = NULL,
  apikey = NULL,
  domain = NULL,
  auth_list = NULL,
  limit = 500,
  flatten = F,
  id = NULL,
  query = NULL,
  responsible_user_id = NULL
)

Arguments

email	Email
apikey	Your api key from settings in interface
domain	Your domain in AmoCRM (xxx in xxx.amocrm.ru)
auth_list	List with auth data, you can build from AmoAuthList
limit	Batch limit, sometimes AmoCRM's API doesn't work properly, you can reduce the value and have a chance to load your data
flatten	Set TRUE if you want to join all the output dataframes You'll have a not tidy-dataframe with left-joining all dataframes
id	Filter. Pass id or vector of ids of contacts
query	Filter. Searching for all fields of contacts String.
responsible_user_id	Filter. Pass id or vector of ids of responsible user ids. You can get ids from AmoUsers().

Value

If flatten is FALSE (default) you'll get a list of 5 tidy-dataframes which you can join by id. You can access it using list_name$dataframe_name.

contacts - all contacts with unnested parameters.

linked_custom_fields — linked custom fields with all parameters.

linked_tags — linked tags with all parameters.

linked_leads — linked leads with all parameters.

linked_customers — linked customers with all parameters.

References

Please READ this: Function documentation in Russian on GitHub

Also nice to read: AmoCRM official documentation

Examples

## Not run: 
library(dplyr)
contacts <- AmoContacts(auth_list = auth_list)
contacts_with_cf <- contacts$contacts %>%
                        left_join(contacts$linked_custom_fields, by = 'id') # not tidy

## End(Not run)

grkhr/amocrm documentation built on May 24, 2021, 5:24 a.m.