Ready to get started?

Download a free trial of the Freshdesk Connector to get started:

 Download Now

Learn more:

Freshdesk Icon Freshdesk Python Connector

Python Connector Libraries for Freshdesk Data Connectivity. Integrate Freshdesk with popular Python tools like Pandas, SQLAlchemy, Dash & petl.

How to use SQLAlchemy ORM to access Freshdesk Data in Python

Create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of Freshdesk data.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for Freshdesk and the SQLAlchemy toolkit, you can build Freshdesk-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Freshdesk data to query, update, delete, and insert Freshdesk data.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Freshdesk data in Python. When you issue complex SQL queries from Freshdesk, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to Freshdesk and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Freshdesk Data

Connecting to Freshdesk data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

FreshDesk makes use of basic authentication. To connect to data, set the following connection properties:

  • Domain: Set this to the domain associated with your FreshDesk account. For example, in your URL:
  • APIKey: Set this to the API key associated with your FreshDesk account. To retrieve your API key, Log into your support Portal -> Click on profile picture in the top right corner -> profile settings page. The API key will be available below the change password section to the right.

Follow the procedure below to install SQLAlchemy and start accessing Freshdesk through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker

Model Freshdesk Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Freshdesk data.

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("freshdesk:///?Domain=MyDomain&APIKey=myAPIKey")

Declare a Mapping Class for Freshdesk Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Tickets table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base() class Tickets(base): __tablename__ = "Tickets" Id = Column(String,primary_key=True) Name = Column(String) ...

Query Freshdesk Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("freshdesk:///?Domain=MyDomain&APIKey=myAPIKey") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Tickets).filter_by(Status="2"): print("Id: ", instance.Id) print("Name: ", instance.Name) print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Tickets_table = Tickets.metadata.tables["Tickets"] for instance in session.execute( == "2")): print("Id: ", instance.Id) print("Name: ", instance.Name) print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Insert Freshdesk Data

To insert Freshdesk data, define an instance of the mapped class and add it to the active session. Call the commit function on the session to push all added instances to Freshdesk.

new_rec = Tickets(Id="placeholder", Status="2") session.add(new_rec) session.commit()

Update Freshdesk Data

To update Freshdesk data, fetch the desired record(s) with a filter query. Then, modify the values of the fields and call the commit function on the session to push the modified record to Freshdesk.

updated_rec = session.query(Tickets).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Status = "2" session.commit()

Delete Freshdesk Data

To delete Freshdesk data, fetch the desired record(s) with a filter query. Then delete the record with the active session and call the commit function on the session to perform the delete operation on the provided records (rows).

deleted_rec = session.query(Tickets).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()

Free Trial & More Information

Download a free, 30-day trial of the CData Python Connector for Freshdesk to start building Python apps and scripts with connectivity to Freshdesk data. Reach out to our Support Team if you have any questions.