> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Worksnaps

> Worksnaps is a time-tracking service designed for remote work that offers detailed project and user activity insights.

![Worksnaps logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/worksnaps.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=7c1e450e62e938ca2a08353eeaacf15a)

* **Category:** time tracking software
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 14
* **Triggers:** 0
* **Slug:** `WORKSNAPS`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Project
>
> **Slug:** `WORKSNAPS_CREATE_PROJECT`
>
> Creates a new project in Worksnaps for tracking time and tasks. Use this tool when you need to set up a new project for time tracking. Projects serve as containers for tasks and time entries. Each project must have a unique name within the account. Note: Account plan limits may restrict the number of projects that can be created.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the project. Must be unique within the account.
>
> **description** `string`
>
> Description of the project explaining its purpose and scope.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create task
>
> **Slug:** `WORKSNAPS_CREATE_TASK`
>
> Tool to create a new task in a specified project. Use after confirming project ID exists.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the task
>
> **user\_id** `integer`
>
> ID of the user to assign the task
>
> **due\_date** `string`
>
> Due date in YYYY-MM-DD format
>
> **project\_id** `integer` *required*
>
> ID of the project to create the task in
>
> **description** `string`
>
> Brief description of the task
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Task
>
> **Slug:** `WORKSNAPS_DELETE_TASK`
>
> Permanently deletes a task from a Worksnaps project. This action is destructive and cannot be undone. Use GET\_TASKS first to find the task\_id, and GET\_PROJECTS to find the project\_id. Returns success=true if the task was deleted. Returns 404 error if project or task does not exist.
>
> #### Input Parameters
>
> **task\_id** `integer` *required*
>
> The unique ID of the task to delete. Can be obtained from GET\_TASKS or CREATE\_TASK actions.
>
> **project\_id** `integer` *required*
>
> The unique ID of the Worksnaps project that contains the task. Can be obtained from GET\_PROJECTS or GET\_PROJECT\_DETAILS actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project Details
>
> **Slug:** `WORKSNAPS_GET_PROJECT_DETAILS`
>
> Tool to retrieve details of a specific project. Use when you have a project\_id and need its details.
>
> #### Input Parameters
>
> **project\_id** `integer` *required*
>
> ID of the project to retrieve. Must be a positive integer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project Report
>
> **Slug:** `WORKSNAPS_GET_PROJECT_REPORT`
>
> Retrieves individual Worksnaps time entries for a project and timestamp range, with the total duration in minutes. Optionally filter by user IDs, task IDs, or online versus offline entries. Timestamps must be Unix seconds at 10-minute interval boundaries; a bad request can also return an empty report.
>
> #### Input Parameters
>
> **task\_ids** `string`
>
> Optional semicolon-separated list of task IDs to filter time entries (e.g., '100;200').
>
> **user\_ids** `string`
>
> Optional semicolon-separated list of user IDs to filter time entries (e.g., '123;456'). If not provided, returns entries for all users in the project.
>
> **project\_id** `integer` *required*
>
> ID of the project to retrieve time entries for.
>
> **to\_timestamp** `integer` *required*
>
> End of the time range as a Unix timestamp (seconds since epoch). Must be at a 10-minute interval boundary and after from\_timestamp.
>
> **from\_timestamp** `integer` *required*
>
> Start of the time range as a Unix timestamp (seconds since epoch). Must be at a 10-minute interval boundary.
>
> **time\_entry\_type** `string`
>
> Optional filter by time entry type. Use 'online' for tracked time with screenshots or 'offline' for manual entries.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Projects
>
> **Slug:** `WORKSNAPS_GET_PROJECTS`
>
> Tool to retrieve a paginated list of projects. Use after authenticating to list accessible projects.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (>=1)
>
> **per\_page** `integer`
>
> Number of projects per page (1-100)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Task Details
>
> **Slug:** `WORKSNAPS_GET_TASK_DETAILS`
>
> Tool to retrieve details of a specific task within a project. Use after confirming project\_id and task\_id.
>
> #### Input Parameters
>
> **task\_id** `integer` *required*
>
> The unique identifier of the task to retrieve
>
> **project\_id** `integer` *required*
>
> The unique identifier of the project containing the task
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Project Tasks
>
> **Slug:** `WORKSNAPS_GET_TASKS`
>
> Tool to retrieve tasks for a specific project. Use when you have a project ID and need its tasks. Example: 'Get tasks for project 42'.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (optional, default=1)
>
> **status** `string ("open" | "closed")`
>
> Filter tasks by status: 'open' or 'closed' (optional)
>
> **user\_id** `integer`
>
> Filter tasks by user ID (optional)
>
> **per\_page** `integer`
>
> Number of tasks per page (optional, default=50)
>
> **project\_id** `integer` *required*
>
> ID of the project to retrieve tasks for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User Account
>
> **Slug:** `WORKSNAPS_GET_USER_ACCOUNT`
>
> Tool to retrieve information about a specific user account. Use after confirming the user\_id.
>
> #### Input Parameters
>
> **user\_id** `integer` *required*
>
> The unique identifier of the user to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User Assignments
>
> **Slug:** `WORKSNAPS_GET_USER_ASSIGNMENTS`
>
> Tool to retrieve a list of all user assignments for a specific project. Returns details about users assigned to the project including their roles, permissions, and contact information.
>
> #### Input Parameters
>
> **project\_id** `integer` *required*
>
> ID of the project to retrieve assignments for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Users
>
> **Slug:** `WORKSNAPS_GET_USERS`
>
> Retrieves a list of all users in the Worksnaps account. Returns user details including id, login, name, email, time zone, and active status. Use this to get user IDs for other user-related operations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Project
>
> **Slug:** `WORKSNAPS_PUT_UPDATE_PROJECT`
>
> Tool to update an existing project. Use when you have project\_id and fields to modify.
>
> #### Input Parameters
>
> **name** `string`
>
> New project name (optional)
>
> **status** `string ("active" | "archived")`
>
> Project status: 'active' or 'archived' (optional)
>
> **end\_date** `string`
>
> Project end date YYYY-MM-DD (optional)
>
> **client\_id** `integer`
>
> New client ID (optional)
>
> **project\_id** `integer` *required*
>
> ID of the project to update
>
> **start\_date** `string`
>
> Project start date YYYY-MM-DD (optional)
>
> **description** `string`
>
> New project description (optional)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Task
>
> **Slug:** `WORKSNAPS_PUT_UPDATE_TASK`
>
> Tool to update details of an existing task. Use when you have project\_id, task\_id, and fields to update.
>
> #### Input Parameters
>
> **name** `string`
>
> New task name (optional)
>
> **status** `string ("open" | "closed")`
>
> New task status: 'open' or 'closed'. Note: Must be combined with 'name' or 'description' update.
>
> **task\_id** `integer` *required*
>
> ID of the task to update
>
> **due\_date** `string`
>
> New due date in YYYY-MM-DD format. Note: Must be combined with 'name' or 'description' update.
>
> **project\_id** `integer` *required*
>
> ID of the project containing the task
>
> **description** `string`
>
> New task description (optional)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update User Account
>
> **Slug:** `WORKSNAPS_PUT_UPDATE_USER_ACCOUNT`
>
> Tool to update information for a specific user account. Use when modifying user details after confirming the user exists. Note: This can only be done by the user himself or by a trusted partner using partner's API token.
>
> #### Input Parameters
>
> **email** `string`
>
> New email address for the user
>
> **user\_id** `integer` *required*
>
> ID of the user account to be updated
>
> **password** `string`
>
> New password for the user
>
> **last\_name** `string`
>
> New last name for the user
>
> **first\_name** `string`
>
> New first name for the user
>
> **timezone\_id** `integer`
>
> Timezone ID for the user (integer ID representing the timezone)
>
> **password\_confirmation** `string`
>
> Confirmation of the new password (required when setting password)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
