contact: View a Contact

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

Description

contact queries the Freshdesk API and returns data related to a contact.

Usage

contact(client, contact_id, contacts_path = "/api/v2/contacts")

Arguments

client	The Freshdesk API client object (see freshdesk_client).
contact_id	The ID of the contact you would like to view.
contacts_path	The path of the contacts API. Defaults to /api/v2/contacts. You should not need to change the default value.

Details

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

Value

A list with the attributes of the contact.

Examples

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

# view contact with id = 42001318958
ct <- contact(fc, 42001318958)

## End(Not run)

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