companies: View a list of Companies

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

Description

companies queries the Freshdesk API and returns a data frame of company data.

Usage

companies(client, companies_path = "/api/v2/companies", max_records = Inf,
  date_fields = company_date_fields)

Arguments

client	The Freshdesk API client object (see freshdesk_client).
companies_path	The path of the companies API. Defaults to /api/v2/companies. 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 company_date_fields which is defined in the package.

Details

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

Value

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

Examples

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

# view companies
cos <- companies(fc)

## End(Not run)

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