> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/clockify.md).

# Clockify

Track time and manage projects in Clockify.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Clockify  | API Key        |

#### Clockify

Connect Clockify with a personal API key to track time and manage projects.

**Set up in Clockify**

1. Prepare the Clockify account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create a personal API key in Clockify under Profile settings > Preferences > Advanced > Manage API keys. Copy it when created because Clockify shows it once.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Clockify**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                                     |
| ------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes                      | Create a personal API key in Clockify under Profile settings > Preferences > Advanced > Manage API keys. Copy it when created because Clockify shows it once. [Provider instructions](https://docs.clockify.me/). |
| Region        | Optional / as applicable | Choose Global, EU Germany (euc1), USA (use2), UK (euw2), or AU (apse2). A regional Clockify workspace requires its matching API host.                                                                             |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Clockify** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Workspaces

List the Clockify workspaces available to the connected account.

**Inputs**

No input fields are required in this catalog entry.

**Outputs**

| Field      | Type          | Description                                         |
| ---------- | ------------- | --------------------------------------------------- |
| Workspaces | object\_array | The accessible workspaces with their IDs and names. |

#### List Projects

Find projects in a Clockify workspace without paging manually.

**Inputs**

| Field             | Type            | Required | Description                                                                                    |
| ----------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------- |
| Workspace         | select (string) | Yes      | The workspace whose projects you want to list. Options load from the selected connection.      |
| Project Name      | string          | No       | Optional text to match in project names.                                                       |
| Access            | select (string) | No       | Optionally return only public or private projects. Available values: Public, Private.          |
| Archived Only     | boolean         | No       | Return only archived projects when enabled. Default: false.                                    |
| Projects Per Page | integer         | No       | The number of projects requested on every Clockify page. Minimum: 1. Maximum: 50. Default: 50. |
| Maximum Pages     | integer         | No       | The maximum number of Clockify pages to fetch. Minimum: 1. Maximum: 4. Default: 4.             |
| Starting Page     | integer         | No       | The Clockify page number to start from. Minimum: 1. Default: 1.                                |

**Outputs**

| Field     | Type          | Description                                                                       |
| --------- | ------------- | --------------------------------------------------------------------------------- |
| Projects  | object\_array | The matching projects and their identifying details.                              |
| Next Page | integer       | The next Clockify page number, or empty when all matching projects were returned. |

#### Create Time Entry

Create one completed Clockify time entry for the connected user. Clockify can reject entries because of account role, Force Timer, a locked period, or required fields.

**Inputs**

| Field                | Type            | Required | Description                                                                                                    |
| -------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| Workspace            | select (string) | Yes      | The workspace that owns this time entry. Options load from the selected connection.                            |
| Start Time           | datetime        | Yes      | When the completed entry started.                                                                              |
| End Time             | datetime        | Yes      | When the completed entry ended.                                                                                |
| Description          | textarea        | No       | Optional details about the work completed.                                                                     |
| Project              | select (string) | No       | Optionally associate the entry with a project. Options load from the selected connection.                      |
| Task                 | select (string) | No       | Optionally associate the entry with a task on the selected project. Options load from the selected connection. |
| Tags                 | string          | No       | Optional comma-separated tag names or IDs.                                                                     |
| Billable             | boolean         | No       | Mark the completed time as billable. Default: false.                                                           |
| Entry Type           | select (string) | No       | Whether this is regular work or a break. Available values: Regular, Break. Default: REGULAR.                   |
| Custom Fields (JSON) | textarea        | No       | Optional JSON object of visible time-entry custom field values.                                                |

**Outputs**

| Field      | Type   | Description                                         |
| ---------- | ------ | --------------------------------------------------- |
| Time Entry | object | The completed Clockify time entry that was created. |

#### Start Timer

Start one running Clockify timer for the connected user. Clockify can reject timers because of account role, Force Timer, required fields, or a locked period.

**Inputs**

| Field         | Type            | Required | Description                                                                                           |
| ------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------- |
| Workspace     | select (string) | Yes      | The workspace where the timer should run. Options load from the selected connection.                  |
| Start Time    | datetime        | No       | When the timer should start, or empty to start now.                                                   |
| Description   | textarea        | No       | What you are working on.                                                                              |
| Project       | select (string) | No       | The project to associate with the timer. Options load from the selected connection.                   |
| Task          | select (string) | No       | An optional task within the selected project. Options load from the selected connection.              |
| Tags          | string          | No       | Optional comma-separated tags for the timer.                                                          |
| Billable      | boolean         | No       | Whether this running time should be billed. Default: false.                                           |
| Entry Type    | select (string) | No       | Whether the timer tracks regular work or a break. Available values: Regular, Break. Default: REGULAR. |
| Custom Fields | textarea        | No       | Advanced custom field values required by some workspaces.                                             |

**Outputs**

| Field              | Type   | Description                                       |
| ------------------ | ------ | ------------------------------------------------- |
| Running Time Entry | object | The running Clockify entry created for the timer. |

#### Stop Timer

Stop the connected user's running timer in a workspace, or return without changes when none is running.

**Inputs**

| Field     | Type            | Required | Description                                                                                           |
| --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------- |
| Workspace | select (string) | Yes      | The workspace where the connected user's timer is running. Options load from the selected connection. |
| End Time  | datetime        | No       | When to stop the timer. Leave empty to use the current time.                                          |

**Outputs**

| Field      | Type    | Description                                     |
| ---------- | ------- | ----------------------------------------------- |
| Stopped    | boolean | Whether a running timer was stopped.            |
| Time Entry | object  | The stopped time entry, if a timer was running. |

#### List Time Entries

Find the connected user's Clockify time entries without paging manually.

**Inputs**

| Field                | Type            | Required | Description                                                                                        |
| -------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------- |
| Workspace            | select (string) | Yes      | The workspace whose entries you want to list. Options load from the selected connection.           |
| From                 | datetime        | No       | Only entries at or after this time.                                                                |
| Until                | datetime        | No       | Only entries at or before this time.                                                               |
| Description Contains | string          | No       | Optional text to search for in entry descriptions.                                                 |
| Project              | select (string) | No       | Optionally return entries for one project. Options load from the selected connection.              |
| Task                 | select (string) | No       | Optionally return entries for one task. Options load from the selected connection.                 |
| Tags                 | string          | No       | Optionally return entries with these tags.                                                         |
| Running Only         | boolean         | No       | Return only the currently running entry when enabled. Default: false.                              |
| Entries Per Page     | integer         | No       | The number of time entries requested on every Clockify page. Minimum: 1. Maximum: 50. Default: 50. |
| Maximum Pages        | integer         | No       | The maximum number of Clockify pages to fetch. Minimum: 1. Maximum: 4. Default: 4.                 |
| Starting Page        | integer         | No       | The Clockify page number to start from. Minimum: 1. Default: 1.                                    |

**Outputs**

| Field        | Type          | Description                                                                      |
| ------------ | ------------- | -------------------------------------------------------------------------------- |
| Time Entries | object\_array | The matching time entries.                                                       |
| Next Page    | integer       | The next Clockify page number, or empty when all matching entries were returned. |

#### Create Project

Create a project in a Clockify workspace.

**Inputs**

| Field        | Type            | Required | Description                                                                                   |
| ------------ | --------------- | -------- | --------------------------------------------------------------------------------------------- |
| Workspace    | select (string) | Yes      | The workspace where the project should be created. Options load from the selected connection. |
| Project Name | string          | Yes      | The new project's name.                                                                       |
| Client       | select (string) | No       | An optional client for the project. Options load from the selected connection.                |
| Billable     | boolean         | No       | Whether time on this project is billable by default. Default: false.                          |
| Visibility   | select (string) | No       | Who can see the project. Available values: Public, Private. Default: PUBLIC.                  |
| Color        | string          | No       | An optional display color for the project.                                                    |
| Note         | textarea        | No       | An optional internal note about the project.                                                  |

**Outputs**

| Field   | Type   | Description                            |
| ------- | ------ | -------------------------------------- |
| Project | object | The Clockify project that was created. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/clockify.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
