agent: View an Agent

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

Description

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

Usage

agent(client, agent_id, agents_path = "/api/v2/agents",
  ticket_scope_lookup = agent_ticket_scope)

Arguments

client	The Freshdesk API client object (see freshdesk_client).
agent_id	The ID of the agent you would like to view.
agents_path	The path of the agents API. Defaults to /api/v2/agents. You should not need to change the default value.
ticket_scope_lookup	Optional dataframe of ticket scope and associated values. Defaults to agent_ticket_scope which is defined in the package.

Details

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

Value

A list with the attributes of the agent.

Examples

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

# view agent with id = 42001318958
a <- agent(fc, 42001318958)

## End(Not run)

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