Package 'lacrmr'

Title: Connect to the 'Less Annoying CRM' API
Description: Connect to the 'Less Annoying CRM' API with ease to get your crm data in a clean and tidy format. 'Less Annoying CRM' is a simple CRM built for small businesses, more information is available on their website <https://www.lessannoyingcrm.com/>.
Authors: ixpantia, family = SRL [cph], Ronny Hernández Mora [aut] , Frans van Dunné [cre, aut]
Maintainer: Frans van Dunné <[email protected]>
License: GPL-3
Version: 1.1.1
Built: 2024-12-26 03:42:43 UTC
Source: https://github.com/ixpantia/lacrmr

Help Index


get_account_information

Description

Return your user account information from Less annoying CRM

Usage

get_account_information(user_code, api_token)

Arguments

user_code

The user code to identify your account

api_token

The api token to connect to your account

Details

For using this function you will need to get your credentials from your Less Annoying CRM. Make sure to have your user code and your api_token.

Examples

## Not run: 
get_account_information(user_code = "6A6E88",
                       api_token = "FBHV7C")

## End(Not run)

get_contact_information

Description

Return the contact information.

Usage

get_contact_information(user_code, api_token, contact_id = "")

Arguments

user_code

The user code to identify your account

api_token

The api token to connect to your account

contact_id

The contact name or other term to make an specific call to the API.

Examples

## Not run: 
get_contact_information(user_code = "6A6E88",
                       api_token = "TQ9XM",
                       contact_id = "Fulano")

## End(Not run)

get_pipeline_report

Description

Return your pipeline report information from Less annoying CRM.

Usage

get_pipeline_report(user_code, api_token, pipelineid)

Arguments

user_code

The user code to identify your account

api_token

The api token to connect to your account

pipelineid

The id of the pipeline you want to get the report from

Details

For this you will need to know the pipelineId, StatusId, and CustomFieldId You can get this PipelineId's at https://www.lessannoyingcrm.com/app/Settings/Api'

Examples

## Not run: 
get_pipeline_report(user_code = "6A6E88",
                    api_token = "96066",
                    pipelineid = "57102821")

## End(Not run)

search_contacts

Description

Return the contacts information from Less annoying CRM.

Usage

search_contacts(user_code, api_token, search_term = "")

Arguments

user_code

The user code to identify your account

api_token

The api token to connect to your account

search_term

The contact name or other term to make an specific call to the API. If you want to search for group enter "Group:GROUP_NAME"

Details

The function will return a data frame. The number of rows depends on the number of entries that a contact_id have in any of the following variables: phone, website, email, address. For example, there could be only 17 unique contact_id's, nonetheless, if one of those contact_id's have three emails, the final data frame will have 19 rows.

Examples

## Not run: 
search_contacts(user_code = "6A6E88",
               api_token = "TQ9XM",
               search_term = "brenesii")

## End(Not run)