Skip to main content

Python SDK for Freshdesk API

Project description

nn-freshdesk-client

This is the Python SDK for the Freshdesk API. It allows you to interact with the Freshdesk API using Python.

Installation

You can install the package from PyPi using pip:

pip install nn-freshdesk-client

Usage

After installation, you can import the package in your Python scripts as follows:

from freshdeskclient import API

Initialize the API

To initialize the API, you need your Freshdesk domain and API key:

api = API(domain='your_domain', api_key='your_api_key')

List all tickets

To list all tickets, you can use the list_all method of the Tickets API:

tickets = api.tickets.list_all()

You can also list all tickets updated between two dates, you can use the list_all_between_dates method of the Tickets API:

tickets = api.tickets.list_all(
    updated_since = "2000-01-01T00:00:00",
    updated_until = "2000-01-02T00:00:00")

List all conversations for a ticket

To list all conversations for a ticket, you also need the ticket ID:

conversations = api.conversations.list_all(ticket_id='your_ticket_id')

Example usage of params

You can use kwargs to pass query parameters to the freshdesk API. For example:

tickets = api.tickets.list_all(updated_since = '2000-01-01T00:00:00Z')

Please refer to the Freshdesk API documentation for more details on the available endpoints and their parameters.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nn-freshdesk-client-0.0.4.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

nn_freshdesk_client-0.0.4-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file nn-freshdesk-client-0.0.4.tar.gz.

File metadata

  • Download URL: nn-freshdesk-client-0.0.4.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.2

File hashes

Hashes for nn-freshdesk-client-0.0.4.tar.gz
Algorithm Hash digest
SHA256 e55f32238fdd26aea509ab22178f5b462cf61577d4f37a9a60a1d035e1f79eaa
MD5 eceb1eb8f018554386a9e57b61255de9
BLAKE2b-256 7b23ea563a5e5ae0b00b46d6abc6e7f4253077f3cb0d4f2025dc6740465fbf50

See more details on using hashes here.

File details

Details for the file nn_freshdesk_client-0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for nn_freshdesk_client-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0108e0d10aa848c7a6b1fbe740f2481f601587e7bc6c844d0c57bcc42afcfe9e
MD5 a46afddb9e369dea881aa0963f26703f
BLAKE2b-256 462ea609a8913642d8c4d5716f9299e212ac557378f15c439f58d2af931d4eca

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page