Creating a project via API

Use the Create Project endpoint when another system owns project creation and Worklix needs a matching record for tracked work and reporting.

Keep API credentials server-side.

Do not expose production tokens in browser code, public repositories or shared client-side configuration.

Request

Send a POST request with a project name. Optional external_id lets your integration preserve the source-system identifier.

POST https://api.worklix.com/v1/projects

{
  "name": "Client onboarding",
  "external_id": "crm_deal_8821",
  "task": { "name": "Migration review" }
}

Example response

A successful create returns the Worklix project ID and any initial task created with it.

{
  "data": {
    "id": "prj_302",
    "name": "Client onboarding",
    "external_id": "crm_deal_8821",
    "tasks": [{ "id": "tsk_22", "name": "Migration review" }]
  }
}

Idempotency

For automation that might retry, send an Idempotency-Key header or store the returned Worklix project ID so the same external project is not created twice.

Idempotency-Key: crm_deal_8821

Was this article helpful?

Creating a project via API

Request

Example response

Idempotency

Know the resource first.Then build the connection.