Skip to content

Latest commit

 

History

History
88 lines (39 loc) · 1.44 KB

Freshdesk-Resources-Agent.md

File metadata and controls

88 lines (39 loc) · 1.44 KB
Raw

Freshdesk\Resources\Agent

Agent resource

This provides access to the agent resources

Methods

current

array|null Freshdesk\Resources\Agent::current(array|null $query)

Get the currently authenticated agent

  • Visibility: public

Arguments

  • $query array|null

all

mixed Freshdesk\Resources\Agent::all(array|null $query)

Get a list of all agents.

Use filters ($query) to view only specific resources (those which match the criteria that you choose).

  • Visibility: public

Arguments

  • $query array|null

create

array|null Freshdesk\Resources\Agent::create(array $data)

Create a resource

Create a resource with the supplied data

  • Visibility: public

Arguments

  • $data array - <p>The data</p>

view

array|null Freshdesk\Resources\Agent::view(integer $id, array|null $query)

View a resource

Use 'include' to embed additional details in the response. Each include will consume an additional credit. For example if you embed the requester and company information you will be charged a total of 3 API credits for the call. See Freshdesk's documentation for details.

  • Visibility: public

Arguments

  • $id integer - <p>The resource id</p>
  • $query array|null