Learn more
 

Ready to get started?

Connect to live data from ClickUp with the API Driver

Connect to ClickUp

In this article

Related articles

Create a Data Access Object for ClickUp Data using JDBI


A brief overview of creating a SQL Object API for ClickUp data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for ClickUp integrates connectivity to live ClickUp data in Java applications. By pairing these technologies, you gain simple, programmatic access to ClickUp data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read ClickUp data.

Create a DAO for the ClickUp Tasks Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyTasksDAO { //request specific data from ClickUp (String type is used for simplicity) @SqlQuery("SELECT Name FROM Tasks WHERE Priority = :priority") String findNameByPriority(@Bind("priority") String priority); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to ClickUp

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to ClickUp.

Start by setting the Profile connection property to the location of the ClickUp Profile on disk (e.g. C:\profiles\ClickUp.apip). Next, set the ProfileSettings connection property to the connection string for ClickUp (see below).

ClickUp API Profile Settings

In order to authenticate to ClickUp, you'll need to provide your API Key. You can find this token in your user settings, under the Apps section. At the top of the page you have the option to generate a personal token. Set the API Key to your personal token in the ProfileSettings property to connect.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the ClickUp JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.api.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for ClickUp will typically look like the following:

jdbc:api:Profile=C:\profiles\ClickUp.apip;ProfileSettings='APIKey=my_personal_token';

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\ClickUp.apip;ProfileSettings='APIKey=my_personal_token';"); MyTasksDAO dao = dbi.open(MyTasksDAO.class); //do stuff with the DAO dao.close();

Read ClickUp Data

With the connection open to ClickUp, simply call the previously defined method to retrieve data from the Tasks entity in ClickUp.

//disply the result of our 'find' method String name = dao.findNameByPriority("High"); System.out.println(name);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for ClickUp by integrating with the CData JDBC Driver for ClickUp. Download a free trial and work with live ClickUp data in custom Java applications today.