AmoTasks: Tasks

In grkhr/amocrm: AmoCRM API client

Description

Function to get tasks.

Usage

AmoTasks(
  email = NULL,
  apikey = NULL,
  domain = NULL,
  auth_list = NULL,
  limit = 500,
  id = NULL,
  type = NULL,
  element_id = NULL,
  responsible_user_id = NULL,
  date_create_from = NULL,
  date_create_to = NULL,
  date_modify_from = NULL,
  date_modify_to = NULL,
  status = NULL,
  created_by = NULL,
  task_type = 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
id	Filter. Pass id or vector of ids of tasks.
type	Filter. Works if element_id is set. Pass "lead", "contact", "company" or "customer".
element_id	Filter. Pass contact/lead/etc id.
responsible_user_id	Filter. Pass id or vector of ids of responsible user ids. You can get ids from AmoUsers().
date_create_from	Filter. Date create of taks. You can pass like '2019-01-01' or like '2019-01-01 12:30:00'.
date_create_to	Filter. Date create of taks. You can pass like '2019-01-01' or like '2019-01-01 12:30:00'.
date_modify_from	Filter. Date modify of taks. You can pass like '2019-01-01' or like '2019-01-01 12:30:00'.
date_modify_to	Filter. Date modify of taks. You can pass like '2019-01-01' or like '2019-01-01 12:30:00'.
status	Filter. Pass 1 if you need done tasks, pass 0 if undone tasks.
created_by	Filter. Tasks by author. Pass if of user or vector of ids.
task_type	Filter. Task by its type. Pass id. You can get id from AmoTaskTypes(). More.

Value

Dataframe in output.

References

Please READ this: Function documentation in Russian on GitHub

Also nice to read: AmoCRM official documentation

Examples

## Not run: 
# simple
tasks <- AmoTasks(auth_list = auth_list)

# filters
tasks <- AmoTasks(auth_list = auth_list,
                  type = 'lead',
                  date_create_from = '2019-02-01 05:00:00',
                  date_create_to = '2019-02-20 17:00:00',
                  status = 0,
                  task_type = 1)

## End(Not run)

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