Developer API - Projects
Introduction
The WorkComposer Projects API enables you to programmatically manage projects within your workspace. Use these endpoints to create, retrieve, update, and delete projects, as well as manage team and user assignments.
Projects are a core organizational unit in WorkComposer, allowing you to group related tasks and track progress across specific initiatives. This API is particularly useful for integrating with project management tools, automating project creation, and synchronizing project data across systems.
Retrieve Projects
This endpoint returns a list of all projects in your workspace. The response includes basic project information such as ID, title, and creation/update timestamps.
API Endpoint
https://api.workcomposer.com/v1/project/
Parameters
Parameter | Required | Description |
---|---|---|
apiKey | Required | Your unique API Key |
limit | Optional | Maximum number of results (default: 100) |
offset | Optional | Number of results to skip for pagination |
Response Example
{
"status": 1,
"projects": [
{
"_id": "60a90der1dcbff17c8ca51fe",
"title": "Test project",
"createdAt": "2021-05-22T13:58:06.867Z",
"updatedAt": "2021-05-22T14:38:34.769Z"
},
{
"_id": "61f537809a6f13f5189cc587",
"title": "Another test project",
"createdAt": "2022-01-29T12:48:13.166Z",
"updatedAt": "2022-01-29T12:53:52.735Z"
}
]
}
Create Project
This endpoint allows you to create a new project in your workspace. You can specify the project title and optionally assign team members and teams during creation.
API Endpoint
https://api.workcomposer.com/v1/project/create/
Parameters
Parameter | Required | Description |
---|---|---|
apiKey | Required | Your unique API Key |
title | Required | Project title |
members[] | Optional | Array of project member user IDs |
teams[] | Optional | Array of project member team IDs |
Response Example
{
"status": 1,
"projectId": "63e38c76e7e26f86bdfdb693"
}
Update Project
This endpoint allows you to update an existing project's details, including its title and team/member assignments. You only need to include the fields you want to update.
API Endpoint
https://api.workcomposer.com/v1/project/update/
Parameters
Parameter | Required | Description |
---|---|---|
apiKey | Required | Your unique API Key |
projectId | Required | ID of the project to update |
title | Optional | Project title |
members[] | Optional | Array of project member user IDs |
teams[] | Optional | Array of project member team IDs |
Response Example
{
"status": 1
}
Delete Project
This endpoint allows you to permanently delete a project from your workspace. Use with caution as this action cannot be undone.
API Endpoint
https://api.workcomposer.com/v1/project/delete/
Parameters
Parameter | Required | Description |
---|---|---|
apiKey | Required | Your unique API Key |
projectId | Required | ID of the project to delete |
Response Example
{
"status": 1
}
Best Practices
Use descriptive project titles: Clear, descriptive project titles make it easier to identify and manage projects through the API.
Manage team assignments efficiently: When creating or updating projects, consider assigning entire teams rather than individual members when appropriate to simplify management.
Store project IDs securely: Save project IDs returned from the Create Project endpoint for future reference, as you'll need them for updates, deletions, and task assignments.
Need Help?
If you have questions about using the Projects API or need assistance with implementing these endpoints in your application, our developer support team is available to help.
Contact Developer Support