> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Timely

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (OAuth) | ✅ |
> | Credentials auto-refresh | ✅ |
> | Auth parameters validation | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | ✅ |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ Observability & data quality
>
> | Tools | Status |
> | - | - |
> | HTTP request logging | ✅ |
> | End-to-end type safety | ✅ |
> | Data runtime validation | ✅ |
> | OpenTelemetry export | ✅ |
> | Slack alerts on errors | ✅ |
> | Integration status API | ✅ |

> [accordion] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
> | Per-customer configurations | ✅ |

### Others

| Function name | Description | Type |
| - | - | - |
| `create-client` | Create a new client (company) in Timely. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-event` | Log a new time entry against a project. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-label` | Create a new label, optionally nested under a parent label. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-project` | Create a new project under a client (company). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-event` | Permanently delete a single logged time entry. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-label` | Permanently delete a label. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-project-safely` | Delete a project after checking for logged time, blocking by default unless confirm is true. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-project` | Permanently delete a project. WARNING: confirmed live to cascade-delete every event (time entry) logged against it. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-client` | Retrieve a single client by ID, including inactive ones. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-event` | Retrieve a single logged time entry by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-label` | Retrieve a single label by ID, including its child labels. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-project-time-summary` | COMPOSITE: get a project's all-time totals AND a date-range-scoped total-plus-entry-breakdown, in one call - fills the gap left by get-project silently ignoring since/upto. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-project` | Retrieve a single project by ID, including its all-time logged duration/cost aggregates. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-time-report` | Get a date-range-scoped rollup of logged time and cost, grouped by client then project. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-user` | Retrieve a single Timely user by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-accounts` | List the Timely accounts this connection can access, to discover the account\_id required by every other action/sync in this registry. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-clients` | List all active clients (companies) in a Timely account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-events` | List logged time entries (Timely events), optionally filtered by day range and/or project. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-labels` | List all labels in the account (hierarchical - top-level labels carry a children array). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-projects` | List all projects in a Timely account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-users` | List all users (team members) in the account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `log-time-to-named-project` | Log time against a project identified by name, creating the project first (under a given or default client) if no project with that exact name already exists. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-client` | Update a client's fields (partial merge), including deactivating it via active:false - the only confirmed way to 'remove' a client since no delete endpoint exists. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-event` | Update a logged time entry (partial merge). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-label` | Update a label's fields (partial merge) - e.g. rename it. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-project` | Update a project's fields (partial merge) - e.g. rename it, change its rate\_type, or flip enable\_labels to allow labeled time entries. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `clients` | Sync all active clients in the connected Timely account(s). | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `events` | Sync logged time entries ('events') within a bounded, caller-configurable day range - full refresh per window, since no working incremental filter exists. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `projects` | Sync all projects in the account. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `users` | Sync all users (team members) in the account. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

> [!NOTE]
>
> Nango has a [Nango-managed OAuth app](https://nango.dev/docs/guides/auth/auth-guide.md#nango-managed-oauth-apps) you can use in development and production. Select it when you create the integration.

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |

## Setup guide

*No setup guide yet.*

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

> [!NOTE]
>
> Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/timely.mdx)

## Useful links

* You need to be the administrator of a [Timely account](https://app.timelyapp.com) to register an app (under Settings -> Devs).
* [Getting started with the Timely API](https://support.timelyapp.com/en/articles/5169847-getting-started-with-timely-s-api)
* [Web API docs (their REST API)](https://dev.timelyapp.com)

> [!NOTE]
>
> Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/timely.mdx)

## API gotchas

* No scopes required.

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/timely.mdx)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.