contacts: View a list of Contacts

In jjanuszczak/freshdeskr: An R Client for the Freshdesk API

Description

contacts queries the Freshdesk API and returns a data frame of contact data.

Usage

contacts(client, contacts_path = "/api/v2/contacts", max_records = Inf,
  date_fields = contact_date_fields)

Arguments

client	The Freshdesk API client object (see freshdesk_client).
contacts_path	The path of the agents API. Defaults to /api/v2/contacts. You should not need to change the default value.
max_records	Specifies the maximum number of records to return.
date_fields	Fields returned by the Freshdesk API that are date fields. Defaults to contact_date_fields which is defined in the package.

Details

This function queries the Freshdesk API to view the details regarding multiple contacts

Value

A data frame of contacts or NULL if there are no contacts.

Examples

## Not run: 
fc <- freshdesk_client("your-domain", "your-api-key")

# view contacts
cs <- contacts(fc)

## End(Not run)

jjanuszczak/freshdeskr documentation built on May 29, 2019, 11:05 p.m.