WorkComposer API Documentation

Introduction

The WorkComposer API enables developers to seamlessly integrate our productivity and project management features into their own applications. Our RESTful API provides programmatic access to tasks, projects, teams, reports, and attendance data, allowing you to build custom workflows and extend WorkComposer's functionality to meet your specific needs.

This documentation provides all the information you need to successfully integrate with the WorkComposer platform.

Getting Started

1

Authentication

All API requests require authentication using an API key. To obtain your API key, sign in to your WorkComposer account and navigate to Settings > API Access.

A valid API key is required to access WorkComposer API. To locate your API key, sign into www.workcomposer.com or create an account. Once signed in, your API key can be located or generated on the API Access page under the Settings section ( https://www.workcomposer.com/workspace/settings/api-access/api-key ).

2

Base URL

All API requests should be made to the following base URL:

https://api.workcomposer.com/v1/

All requests must use HTTPS and include your API key as a parameter.

3

Request Format

All requests should use the POST method with parameters submitted in the request body as JSON.

Example Request

// POST https://api.workcomposer.com/v1/projects/list
{
  "apiKey": "YOUR_API_KEY",
  "limit": 10,
  "offset": 0
}

Important: Always include your API key with each request as shown in the example above.

API Resources

Response Format

All API responses are returned in JSON format. Each response includes a status field indicating whether the request was successful (1) or failed (0).

// HTTP Status: 200 OK
{
  "status": 1,
  "data": {
    // Response data specific to the endpoint
    "id": 12345,
    "name": "Sample Project",
    "created": "2023-09-15T14:30:00Z"
  }
}

// HTTP Status: 400 Bad Request
{
  "status": 0,
  "error": "Invalid API key or missing required parameters",
  "errorCode": 400
}