Chat with us, powered by LiveChat
Skip to main content

Developer API - Tasks

Introduction

The WorkComposer Tasks API enables you to programmatically manage tasks within your workspace. Use these endpoints to create, retrieve, update, and delete tasks, as well as manage task assignments and statuses.

Tasks are the fundamental units of work in WorkComposer, allowing you to track individual activities, assign responsibilities, and monitor progress. This API is particularly useful for integrating with project management tools, automating task creation, and synchronizing task data across systems.

Retrieve Tasks

This endpoint returns a list of tasks based on the provided filters. You can retrieve tasks for a specific project or get details about a particular task using its ID.

API Endpoint

POSThttps://api.workcomposer.com/v1/task/

Parameters

ParameterRequiredDescription
apiKey Required Your unique API Key
projectId or taskId Required Project ID or Task ID to filter tasks
limit Optional Maximum number of results (default: 100)
offset Optional Number of results to skip for pagination

Response Example

{
  "status": 1,
  "tasks": [
    {
      "taskId": "6743fee486bd91efc476f1b0",
      "title": "Update task api documentation",
      "description": "Task description",
      "assignedTo": "1725feb8eac6e38ea34d9374",
      "status": "ToDo",
      "projectId": "6745feb8eac6eb8ba34d2475",
      "priority": 2,
      "authorId": "66ba3dfb388f16f18d7786a3",
      "createdAt": "2024-11-26T17:01:24.230Z",
      "updatedAt": "2024-11-26T17:01:24.230Z"
    }
  ]
}

Create Task

This endpoint allows you to create a new task within a project. You can specify the task title, description, priority, and assignee during creation.

API Endpoint

POSThttps://api.workcomposer.com/v1/task/create/

Parameters

ParameterRequiredDescription
apiKey Required Your unique API Key
title Required Task title
projectId Required Project ID
priority Optional Priority: 1 (Low), 2 (Medium), or 3 (High)
description Optional Task description
assigneeId Optional ID of the user to assign the task to

Response Example

{
  "status": 1,
  "taskId": "19ba3dfb388a11f18f7791c3"
}

Update Task

This endpoint allows you to update an existing task's details, including its title, description, priority, status, and assignee. You only need to include the fields you want to update.

API Endpoint

POSThttps://api.workcomposer.com/v1/task/update/

Parameters

ParameterRequiredDescription
apiKey Required Your unique API Key
taskId Required ID of the task to update
title Optional Task title
priority Optional Priority: 1 (Low), 2 (Medium), or 3 (High)
description Optional Task description
assigneeId Optional ID of the user to assign the task to
status Optional Status: "Done", "ToDo", or "In Progress"

Response Example

{
  "status": 1
}

Delete Task

This endpoint allows you to permanently delete a task from your workspace. Use with caution as this action cannot be undone.

API Endpoint

POSThttps://api.workcomposer.com/v1/task/delete/

Parameters

ParameterRequiredDescription
apiKey Required Your unique API Key
taskId Required ID of the task to delete

Response Example

{
  "status": 1
}

Best Practices

Use descriptive task titles: Clear, concise task titles make it easier to identify and manage tasks through the API and in the WorkComposer interface.

Implement pagination: When retrieving large numbers of tasks, use the limit and offset parameters to paginate results for better performance.

Store task IDs: Save task IDs returned from the Create Task endpoint for future reference, as you'll need them for updates, deletions, and status changes.

Need Help?

If you have questions about using the Tasks API or need assistance with implementing these endpoints in your application, our developer support team is available to help.

Contact Developer Support