Connecting to Clockify

Using API Key Authentication

To authenticate using an API Key, you need to obtain your API Key from your Clockify account settings.

You can then connect by setting the AuthScheme to APIKey and providing your API key:

AuthScheme: Set this to APIKey.
APIKey: Set this to your API key from Clockify.

To obtain your API Key:

Log into your Clockify account at https://app.clockify.me/
Click on your profile picture in the top-right corner
Select "Profile settings"
Scroll down to the "API" section
Copy your API Key

Working with Workspaces

Many tables in Clockify require a WorkspaceId parameter to retrieve data. You can find your Workspace ID by querying the Workspaces table or by looking at the URL when logged into Clockify (e.g., https://app.clockify.me/tracker/{WORKSPACE_ID}).

You can either set the WorkspaceId as a connection property for a default workspace, or specify it in your SQL queries using the WHERE clause. For example:

SELECT * FROM Projects WHERE WorkspaceId='your-workspace-id'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	The API Key from Clockify. You can obtain your API Key from your Clockify account settings under the Profile Settings page.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
WorkspaceId	The Workspace ID to scope queries to a specific workspace. Many tables in Clockify require a WorkspaceId parameter to retrieve data. You can find your Workspace ID by querying the Workspaces table or by inspecting the URL when logged into Clockify.