Freshdesk
Overview
Freshdesk is an omnichannel customer support platform utilized.
API
- class parsons.Freshdesk(domain, api_key)[source]
Instantiate FreshDesk Class
- Args:
- domain:
The subdomain of the FreshDesk account. Not required if
FRESHDESK_DOMAIN
env variable set.- api_key:
The FreshDesk provided application key. Not required if
FRESHDESK_API_KEY
env variable set.
- Returns:
FreshDesk Class
- get_tickets(ticket_type=None, requester_id=None, requester_email=None, company_id=None, updated_since='2016-01-01', expand_custom_fields=False)[source]
List tickets.
Warning
Deleted and Spam tickets are not included. However they can be pulled separately by utilizing the
ticket_type
parameter.Warning
Freshdesk will return a maximum of 9,000 tickets. To access additional tickets, utilize the
updated_since
parameter.- Args:
- ticket_type: str
Filter by type of ticket to filter by. Valid fields include
new_and_my_open
,watching
,spam
anddeleted
.- requester_id: int
Filter by requester id.
- requester_email: str
Filter by requester email.
- company_id: int
Filter by company_id.
- expand_custom_fields: boolean
Expand nested custom fields to their own columns.
- Returns:
- Parsons Table
See Parsons Table for output options.
- get_contacts(email=None, mobile=None, phone=None, company_id=None, state=None, updated_since=None, expand_custom_fields=None)[source]
Get contacts.
- Args:
- email: str
Filter by email address.
- mobile: str
Filter by mobile phone number.
- phone: str
Filter by phone number.
- expand_custom_fields: boolean
Expand nested custom fields to their own columns.
- get_companies(expand_custom_fields=False)[source]
List companies.
- Args:
- expand_custom_fields: boolean
Expand nested custom fields to their own columns.
- Returns:
- Parsons Table
See Parsons Table for output options.
- get_agents(email=None, mobile=None, phone=None, state=None)[source]
List agents.
- Args:
- email: str
Filter by email address.
- mobile: str
Filter by mobile phone number
- phone: str
Filter by phone number
- state: str
Filter by state
- Returns:
- Parsons Table
See Parsons Table for output options.