WorkComposer API v2.0

1 Download the API Specification

The WorkComposer API v2.0 is described using the OpenAPI 3.1.0 standard. You can download the specification file and use it with any OpenAPI-compatible tool to explore, test, or generate client code for the API.

2 Authentication Quick Start

All API requests require an API key passed in the X-API-Key request header.

curl -X GET "https://api.workcomposer.com/v2/users" \
  -H "X-API-Key: your_api_key_here"

{
  "data": [
    {
      "id": "usr_abc123",
      "email": "user@example.com",
      "name": "John Doe",
      "role": "member",
      ...
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 25,
    "hasMore": true,
    "nextCursor": "eyJpZCI6MTIzfQ"
  }
}

3 Import into Postman

Postman is one of the most popular API development and testing tools. Import the WorkComposer API spec to get a ready-to-use collection with all endpoints.

1. 1

   Open Postman and click Import in the top-left corner (or press Ctrl+O / ⌘+O).

2. 2

   Select the Link tab and paste the OpenAPI spec URL:

   http://api.wc.com/v2/openapi.json
3. 3

   Click Import. Postman will create a collection named "WorkComposer API" with all endpoints organized by resource.

4. 4

   Set up authentication: go to the collection's Authorization tab, choose API Key, set the key name to X-API-Key (Header), and paste your API key as the value.

4 Import into Insomnia

Insomnia is a popular open-source API client with a clean interface.

1. 1

   Open Insomnia and go to File → Import (or click the + button and select Import).

2. 2

   Choose From URL and paste:

   http://api.wc.com/v2/openapi.json
3. 3

   Click Import. All endpoints will be imported with request schemas and example data.

4. 4

   Configure authentication: in the base environment, add a header X-API-Key with your API key value.

5 Import into Thunder Client (VS Code)

Thunder Client is a lightweight REST client extension for Visual Studio Code — ideal for developers who prefer staying in their editor.

1. 1

   Install the Thunder Client extension from the VS Code marketplace.

2. 2

   Open Thunder Client from the sidebar, go to Collections, click the menu icon (⋯), and select Import.

3. 3

   Choose Import from URL and paste the OpenAPI spec URL, or download the JSON file first and select Import from File.

4. 4

   Add your API key under Env → Global or set the X-API-Key header in each request.

6 Use with cURL

cURL is available on all major operating systems and is the quickest way to test API endpoints from the command line.

curl -X GET "https://api.workcomposer.com/v2/projects?limit=10" \
  -H "X-API-Key: your_api_key_here"

curl -X POST "https://api.workcomposer.com/v2/projects" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "name": "My New Project",
    "description": "Project created via API"
  }'

# First page
curl -X GET "https://api.workcomposer.com/v2/tasks?limit=50" \
  -H "X-API-Key: your_api_key_here"

# Next page (use nextCursor from previous response)
curl -X GET "https://api.workcomposer.com/v2/tasks?limit=50&cursor=eyJpZCI6MTIzfQ" \
  -H "X-API-Key: your_api_key_here"