> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Timely > Timely is an automatic time-tracking platform capturing activity across applications, calendars, and devices, creating detailed timesheets for billing or productivity insights Timely is an automatic time-tracking platform capturing activity across applications, calendars, and devices, creating detailed timesheets for billing or productivity insights `timely` · **41 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth timely run auth timely --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run timely # common commands run timely --all # every command ``` ```ts theme={"theme":"github-dark"} import { timely } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `create-day-locking` | Tool to create a day locking entry that prevents editing of time entries for specific dates and users. | | `create-report` | Tool to generate reports for a Timely account with optional filters. | | `create-team` | Tool to create a new team in the specified Timely account. Use when organizing users into teams for better collaboration and project management. | | `create-webhook` | Tool to create a new webhook for the specified account. Use after specifying the target URL and event subscriptions. | | `delete-webhook` | Tool to delete an existing webhook by its ID. Use when you need to remove a webhook subscription from an account. | | `filter-reports` | Tool to filter Timely reports based on date range, users, projects, labels, teams, and billing status. | | `get-activities` | Tool to retrieve all activities (audit trail) for a Timely account. | | `get-current-permissions` | Tool to retrieve the current user's permissions for a specified account. | | `get-current-user` | Tool to retrieve the currently authenticated user. Use when you need to get details of the logged-in user. | | `get-label` | Tool to retrieve a label by ID from a Timely account. Use when you need to fetch label details such as name, color, and parent relationship. | | `get-project` | Tool to retrieve a single project by its ID. Use when you need detailed information about a specific project, such as its name, budget, billable... | | `get-user` | Tool to retrieve a user by ID from a Timely account. Use when you need to fetch user details such as name, email, and avatar. | | `get-user-permissions` | Tool to retrieve a user's permissions by their ID. Use when you need to check what permissions a specific user has in a Timely account. | | `list-clients` | Tool to list all clients in a Timely account with optional filtering and sorting. | | `list-events` | Tool to list all events (time entries) in a Timely account with optional filtering by date range, users, and projects. | | `list-project-events` | Tool to list all events (time entries) for a specific project in Timely. | | `list-projects` | Tool to list all projects in a Timely account with optional filtering and sorting. | | `list-teams` | Tool to list all teams in the specified Timely account. Use when you need to retrieve all teams for collaboration and project management purposes. | | `list-user-events` | Tool to list all events (time entries) for a specific user in Timely. | | `list-users` | Tool to list all users in a Timely account with optional filtering and pagination. | | `process-bulk-events` | Tool to create, update, or delete multiple events in a single bulk operation. | | `retrieve-account` | Tool to retrieve details of a specific account by its ID. Use when you need to fetch fresh account info after confirming the ID. | | `update-project` | Tool to update a project by ID in a Timely account. Use when you need to modify project details such as name, description, billing status, or archive a project. | | `update-user` | Tool to update a user by ID in a Timely account. Use when you need to modify user details such as email, name, role, or status. | | `update-webhook` | Tool to update an existing webhook by ID. Use when you need to modify webhook settings such as URL, subscriptions, or active status. | | Tool | What it does | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `create-client` | Tool to create a new client in the specified Timely account. | | `create-day-locking` | Tool to create a day locking entry that prevents editing of time entries for specific dates and users. | | `create-label` | Tool to create a new label in the specified Timely account. Use when you need to create a label for categorizing projects, time entries, or other resources. | | `create-report` | Tool to generate reports for a Timely account with optional filters. | | `create-team` | Tool to create a new team in the specified Timely account. Use when organizing users into teams for better collaboration and project management. | | `create-webhook` | Tool to create a new webhook for the specified account. Use after specifying the target URL and event subscriptions. | | `delete-label` | Tool to delete a label by ID from a Timely account. Use when you need to remove an existing label. | | `delete-team` | Tool to delete a team by its ID. Use when you need to remove a specific team from the account. | | `delete-webhook` | Tool to delete an existing webhook by its ID. Use when you need to remove a webhook subscription from an account. | | `filter-reports` | Tool to filter Timely reports based on date range, users, projects, labels, teams, and billing status. | | `get-activities` | Tool to retrieve all activities (audit trail) for a Timely account. | | `get-client` | Tool to retrieve details of a specific client by its ID. Use when you need to fetch client information such as name, color, active status, or external references. | | `get-current-permissions` | Tool to retrieve the current user's permissions for a specified account. | | `get-current-user` | Tool to retrieve the currently authenticated user. Use when you need to get details of the logged-in user. | | `get-label` | Tool to retrieve a label by ID from a Timely account. Use when you need to fetch label details such as name, color, and parent relationship. | | `get-project` | Tool to retrieve a single project by its ID. Use when you need detailed information about a specific project, such as its name, budget, billable... | | `get-team` | Tool to retrieve details of a specific team by its ID. Use when you need to fetch team information including name, color, and members. | | `get-user` | Tool to retrieve a user by ID from a Timely account. Use when you need to fetch user details such as name, email, and avatar. | | `get-user-capacities` | Tool to retrieve capacity information for a specific user in a Timely account. | | `get-user-permissions` | Tool to retrieve a user's permissions by their ID. Use when you need to check what permissions a specific user has in a Timely account. | | `get-webhook` | Tool to retrieve a specific webhook by its ID. Use when you need to check the configuration or status of an existing webhook. | | `list-accounts` | Retrieve all accessible Timely accounts for the authenticated user. | | `list-clients` | Tool to list all clients in a Timely account with optional filtering and sorting. | | `list-events` | Tool to list all events (time entries) in a Timely account with optional filtering by date range, users, and projects. | | `list-forecasts` | Tool to list all forecasts (tasks) in a Timely account with optional date filtering. | | `list-labels` | Tool to list all labels in a Timely account. Use when you need to discover label IDs or names for organizing projects and time entries. | | `list-project-events` | Tool to list all events (time entries) for a specific project in Timely. | | `list-projects` | Tool to list all projects in a Timely account with optional filtering and sorting. | | `list-roles` | Tool to list all available roles in a Timely account. Use when you need to discover role IDs or names for user assignment or permission management. | | `list-teams` | Tool to list all teams in the specified Timely account. Use when you need to retrieve all teams for collaboration and project management purposes. | | `list-user-events` | Tool to list all events (time entries) for a specific user in Timely. | | `list-users` | Tool to list all users in a Timely account with optional filtering and pagination. | | `list-webhooks` | Tool to list all webhooks in the specified account. Use when you need to see existing webhook configurations or verify webhook setup. | | `process-bulk-events` | Tool to create, update, or delete multiple events in a single bulk operation. | | `retrieve-account` | Tool to retrieve details of a specific account by its ID. Use when you need to fetch fresh account info after confirming the ID. | | `update-client` | Tool to update an existing client by ID in Timely. Use when you need to modify client details such as name, status, color, or external ID. | | `update-day-locking` | Tool to update day locking settings for specified users and dates. | | `update-label` | Tool to update a label by ID in a Timely account. Use when you need to modify an existing label's name, color, or hierarchy. | | `update-project` | Tool to update a project by ID in a Timely account. Use when you need to modify project details such as name, description, billing status, or archive a project. | | `update-user` | Tool to update a user by ID in a Timely account. Use when you need to modify user details such as email, name, role, or status. | | `update-webhook` | Tool to update an existing webhook by ID. Use when you need to modify webhook settings such as URL, subscriptions, or active status. | [Open Timely in the console →](https://app.boxd.sh/integrations/detail/timely)