> ## 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.

# Onedesk

> OneDesk is an all-in-one platform combining help desk and project management functionalities, enabling teams to manage customer support and project tasks seamlessly.

![Onedesk logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/onedesk.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=c3f30245a8390e3297f55a0d558ddd38)

* **Category:** customer support
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 24
* **Triggers:** 0
* **Slug:** `ONEDESK`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Worklog Entry
>
> **Slug:** `ONEDESK_CREATE_WORKLOG`
>
> Create a worklog entry to track time spent on a work item (task, ticket, project, etc.). Records the start and finish time, work hours, completion percentage, and billability. Use this after obtaining a valid item\_id from actions like GET\_TASK\_DETAILS.
>
> #### Input Parameters
>
> **works** `number`
>
> Number of work units (hours) logged, non-negative
>
> **item\_id** `integer` *required*
>
> ID of the work item (task, ticket, project, etc.) to log time against
>
> **billable** `boolean`
>
> Whether this work is billable
>
> **comments** `string`
>
> Comments or notes describing the work performed
>
> **date\_start** `string` *required*
>
> Start date and time of the work period in ISO 8601 format
>
> **percentage** `number`
>
> Percentage of work completion (0-100)
>
> **date\_finish** `string` *required*
>
> Finish date and time of the work period in ISO 8601 format
>
> **lifecycle\_status\_id** `integer`
>
> Lifecycle status ID for the worklog entry (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] Delete Attachment
>
> **Slug:** `ONEDESK_DELETE_ATTACHMENT`
>
> Delete a specific attachment from OneDesk by its ID. To use this tool, provide the attachment\_id. Note that the OneDesk Public API has limited attachment management capabilities. Attachments are typically associated with items (tickets/tasks) and can be viewed via GET\_ATTACHMENTS when fetching item details. Returns deleted=True if the attachment was successfully deleted (200/202/204). Returns deleted=False if the attachment was not found (404).
>
> #### Input Parameters
>
> **attachment\_id** `integer` *required*
>
> Unique identifier of the attachment to delete
>
> #### 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 Comment
>
> **Slug:** `ONEDESK_DELETE_COMMENT`
>
> Deletes a comment from OneDesk by its ID. Use this tool to permanently remove a comment when it's no longer needed. Note: OneDesk's Public API has limited DELETE support for comments. This action tries multiple possible endpoints to maximize compatibility. Comments may be referred to as "conversations" in the API. Example: \{'comment\_id': 12345} Returns: Deletion status with context about success/failure (e.g., comment not found, permission denied)
>
> #### Input Parameters
>
> **comment\_id** `integer` *required*
>
> Unique identifier of the comment to delete
>
> #### 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 Customer
>
> **Slug:** `ONEDESK_DELETE_CUSTOMER`
>
> Delete a OneDesk customer by ID. The operation can also delete a user record with that ID. It reports success when deletion is accepted and false when the record is not found.
>
> #### Input Parameters
>
> **customer\_id** `string` *required*
>
> The unique identifier of the customer to delete from OneDesk. This can be a numeric ID or alphanumeric string.
>
> #### 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 Message
>
> **Slug:** `ONEDESK_DELETE_MESSAGE`
>
> Delete a OneDesk message by its numeric ID. The operation can also report success when the message is absent.
>
> #### Input Parameters
>
> **message\_id** `integer` *required*
>
> The unique numeric identifier of the message to delete from OneDesk
>
> #### 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 Project
>
> **Slug:** `ONEDESK_DELETE_PROJECT`
>
> Delete a OneDesk project by its ID. This operation is unavailable through this tool; use the OneDesk web application to delete the project instead.
>
> #### Input Parameters
>
> **project\_id** `integer` *required*
>
> Unique identifier of the project to delete
>
> #### 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 Requirement
>
> **Slug:** `ONEDESK_DELETE_REQUIREMENT`
>
> Delete a requirement from OneDesk. Requirements in OneDesk are work items used for product development, feature requests, and specifications. They are one of the core work item types (tickets, tasks, requirements, issues). IMPORTANT: This operation may not be supported by all OneDesk Public API versions. If deletion fails, the API may only support soft-delete or archiving through status updates. Use when you need to permanently remove a requirement by its internal numeric ID. Example: \{'requirement\_id': 12345}
>
> #### Input Parameters
>
> **requirement\_id** `integer` *required*
>
> Unique internal ID of the requirement to delete. This is the numeric 'id' field returned by OneDesk API, not the externalId.
>
> #### 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:** `ONEDESK_DELETE_TASK`
>
> Tool to delete a specific task. Use when you need to remove an existing task by its ID after confirming its details.
>
> #### Input Parameters
>
> **task\_id** `integer` *required*
>
> Unique identifier of the task to delete
>
> #### 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 Ticket
>
> **Slug:** `ONEDESK_DELETE_TICKET`
>
> Deletes a ticket from OneDesk by its internal ID. Use this tool to permanently remove a ticket when it's no longer needed. The ticket will be moved to the 'Deleted Items' project and scheduled for permanent deletion after 7 days. Note: OneDesk's Public API has limited DELETE support. This action tries multiple possible endpoints to maximize compatibility. Example: \{'ticket\_id': 123} Returns: Deletion status with context about success/failure (e.g., ticket not found, rate limited, permission denied)
>
> #### Input Parameters
>
> **ticket\_id** `integer` *required*
>
> Unique identifier of the ticket to delete
>
> #### 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 Timesheet
>
> **Slug:** `ONEDESK_DELETE_TIMESHEET`
>
> Tool to delete a timesheet by its ID. Use when you need to remove a specific timesheet after confirming it's no longer needed. Example: \{'timesheet\_id': 123}
>
> #### Input Parameters
>
> **timesheet\_id** `integer` *required*
>
> Unique identifier of the timesheet to delete
>
> #### 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 User
>
> **Slug:** `ONEDESK_DELETE_USER`
>
> Delete a OneDesk user by unique user ID. The action returns success and status information for recognized responses, including permission and rate-limit errors; other failures can raise an error.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The unique identifier of the user to delete from OneDesk
>
> #### 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 Attachments
>
> **Slug:** `ONEDESK_GET_ATTACHMENTS`
>
> Retrieve attachments for a specific item by its external ID by extracting attachment data from the item response. An empty result can mean that attachments were not included in the response.
>
> #### Input Parameters
>
> **external\_id** `string` *required*
>
> External ID of the item (ticket/task) to retrieve attachments from. Required because the Public API only supports fetching items by external ID.
>
> #### 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 Comment Details
>
> **Slug:** `ONEDESK_GET_COMMENT_DETAILS`
>
> Retrieve detailed information for a specific comment by its ID. This action attempts to fetch comment details from OneDesk using the comment ID. It tries multiple endpoint patterns to maximize compatibility with different API versions. Note: The OneDesk Public REST API has limited support for retrieving comments. If the comment ID doesn't exist or the endpoint is not available, this action will fail.
>
> #### Input Parameters
>
> **comment\_id** `integer` *required*
>
> The unique identifier of the comment 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 Comments
>
> **Slug:** `ONEDESK_GET_COMMENTS`
>
> Retrieve OneDesk comments or discussion posts, optionally passing an item ID to filter by the associated work item. Returns the comments found; an empty list can also result when the response does not contain a recognized comment list.
>
> #### Input Parameters
>
> **item\_id** `integer`
>
> Filter comments by associated item (ticket/task) ID (not supported by public API)
>
> #### 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 Feedback Items
>
> **Slug:** `ONEDESK_GET_FEEDBACK`
>
> List feedback items from OneDesk. This operation is currently unavailable in this action; use the OneDesk web application to view feedback instead.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination, starting at 1
>
> **per\_page** `integer`
>
> Number of items per page for pagination, max 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 Feedback Details
>
> **Slug:** `ONEDESK_GET_FEEDBACK_DETAILS`
>
> Retrieve detailed information about a specific item in OneDesk by its internal ID. This endpoint retrieves ANY type of item (Tickets, Tasks, Feedback, etc.), not just feedback items. Use this action when you have an item's internal ID and need comprehensive details including: - Basic info (title, description, status, priority) - Creator and assignee information - Project association - Timestamps and lifecycle state - Direct web URL to view the item The internal ID is the numeric ID shown in the OneDesk application.
>
> #### Input Parameters
>
> **feedback\_id** `integer` *required*
>
> Internal ID of the item to retrieve (works for tickets, tasks, feedback, and all other item types)
>
> #### 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 Issue Details
>
> **Slug:** `ONEDESK_GET_ISSUE_DETAILS`
>
> Retrieve details of a OneDesk issue by its numeric ID, including available title, description, status, priority and timestamps. Use this to inspect an issue for tracking or reporting.
>
> #### Input Parameters
>
> **issue\_id** `integer` *required*
>
> Unique identifier of the issue 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 Issues
>
> **Slug:** `ONEDESK_GET_ISSUES`
>
> List issues from OneDesk. This operation is currently unavailable in this action; use the OneDesk web application to view and manage issues instead.
>
> #### 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 Messages
>
> **Slug:** `ONEDESK_GET_MESSAGES`
>
> List messages from OneDesk. This operation is currently unavailable in this action; use the OneDesk web application to view messages instead.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of messages to return
>
> **offset** `integer`
>
> Offset for pagination
>
> **search** `string`
>
> Search text within message bodies
>
> **direction** `string`
>
> Direction of the message, e.g. 'inbound' or 'outbound'
>
> **ticket\_id** `integer`
>
> Filter messages by associated ticket ID
>
> **contact\_id** `integer`
>
> Filter messages by contact/customer ID
>
> #### 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 Requirements
>
> **Slug:** `ONEDESK_GET_REQUIREMENTS`
>
> List requirements from OneDesk. This operation is currently unavailable in this action; use the OneDesk web application for requirement management instead.
>
> #### 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:** `ONEDESK_GET_TASK_DETAILS`
>
> Retrieves comprehensive details of a specific task/item in OneDesk by its ID. Use this tool when you need complete information about a task including its title, description, status, assignee, priority, due date, and project association. OneDesk uses 'items' to represent various work units including tasks, tickets, issues, and requirements. Returns detailed task information if found, or raises an error if the task doesn't exist or you don't have permission to access it.
>
> #### Input Parameters
>
> **task\_id** `integer` *required*
>
> Unique numeric identifier of the task/item to retrieve (must be a positive integer, e.g., 1, 2, 123)
>
> #### 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 Tickets
>
> **Slug:** `ONEDESK_GET_TICKETS`
>
> Retrieve tickets from OneDesk by querying a range of item IDs. **API LIMITATION WORKAROUND**: The OneDesk Public API does not provide a direct endpoint to list all tickets. This action works around this by: 1. Querying individual items by ID within the specified range (start\_id to end\_id) 2. Filtering results to return only items with type='Ticket' 3. Limiting results to the max\_tickets parameter **How it works**: - The action queries items sequentially from start\_id to end\_id - Only items with type='Ticket' are included in the results - Stops after collecting max\_tickets tickets or reaching end\_id - Non-existent IDs and non-ticket items (tasks, folders, etc.) are skipped **Best practices**: - Use smaller ranges (e.g., 1-50) for faster responses - Adjust start\_id based on your known ticket ID ranges - Use max\_tickets to limit the number of results The OneDesk Public API endpoint used: GET /rest/public/items/id/\{id}
>
> #### Input Parameters
>
> **end\_id** `integer`
>
> Ending item ID for the range to query (inclusive, must be >= start\_id)
>
> **start\_id** `integer`
>
> Starting item ID for the range to query (inclusive, must be >= 1)
>
> **max\_tickets** `integer`
>
> Maximum number of tickets to return (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 Timesheet Details
>
> **Slug:** `ONEDESK_GET_TIMESHEET_DETAILS`
>
> Retrieve details of a OneDesk timesheet entry by ID, such as its user, project, duration and date when available. If details cannot be retrieved, the result may contain only the requested ID; this does not confirm the timesheet exists.
>
> #### Input Parameters
>
> **timesheet\_id** `integer` *required*
>
> Unique identifier of the timesheet 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 Worklogs
>
> **Slug:** `ONEDESK_GET_WORKLOGS`
>
> Retrieve OneDesk worklogs with optional object, user and date-range filters. Use limit and offset for pagination; the limit defaults to 100 and permits up to 1,000 entries.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of worklogs to return. Defaults to 100, maximum 1000.
>
> **offset** `integer`
>
> Number of worklogs to skip for pagination. Defaults to 0.
>
> **to\_date** `string`
>
> Filter worklogs up to this date (ISO 8601 format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). If not provided, no end date filter is applied.
>
> **user\_id** `string`
>
> Filter worklogs by specific user ID. If not provided, returns worklogs for all users.
>
> **from\_date** `string`
>
> Filter worklogs from this date onwards (ISO 8601 format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ). If not provided, no start date filter is applied.
>
> **object\_id** `string`
>
> Filter worklogs by specific object ID (e.g., ticket, task, or project ID). If not provided, returns all worklogs.
>
> #### 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
