company: View an Company

Description Usage Arguments Details Value Examples

Description

agent queries the Freshdesk API and returns data related to an comapny.

Usage

1
company(client, company_id, companies_path = "/api/v2/companies")

Arguments

client

The Freshdesk API client object (see freshdesk_client).

company_id

The ID of the company you would like to view.

companies_path

The path of the companies API. Defaults to /api/v2/companies. You should not need to change the default value.

Details

This function queries the Freshdesk API based on company id to view the details regarding this company.

Value

A list with the attributes of the company

Examples

1
2
3
4
5
6
7
## Not run: 
fc <- freshdesk_client("your-domain", "your-api-key")

# view compnay with id = 42001318958
co <- company(fc, 42001318958)

## End(Not run)

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