Retrieving projects via API

The Projects endpoint returns workspace projects visible to the authenticated integration. Use status filters when you need active, archived or all project records.

Keep API credentials server-side.

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

Request

The default request returns active projects. Add status=all when a synchronization workflow also needs archived records.

GET https://api.worklix.com/v1/projects?status=active

Example response

Projects can include nested task summaries so your external system can preserve project/task relationships.

{
  "data": [
    {
      "id": "prj_302",
      "name": "Client onboarding",
      "status": "active",
      "tasks": [{ "id": "tsk_22", "name": "Migration review", "status": "open" }]
    }
  ]
}

Filtering and pagination

Use status and pagination controls rather than assuming all projects fit in one response. Large workspaces should synchronize in bounded pages.

Was this article helpful?

Retrieving projects via API

Request

Example response

Filtering and pagination

Know the resource first.Then build the connection.