Skip to main content
GET
/
workstreams
List workstreams for a project
curl --request GET \
  --url https://openlens.com/api/workstreams \
  --header 'Authorization: Bearer <token>'
{
  "workstreams": [
    {
      "workstream": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "topicIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "attributes": [
          "<string>"
        ],
        "archivedAt": "2023-11-07T05:31:56Z",
        "currentGoal": {
          "effectiveFrom": "2023-11-07T05:31:56Z",
          "goalText": "<string>",
          "targetVisibility": 50,
          "targetDeadline": "2023-12-25"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "currentVisibility": 123,
      "deltaPts": 123,
      "windowDays": 123,
      "sparkline": [
        {
          "date": "2023-12-25",
          "visibility": 123
        }
      ],
      "progressPct": 123,
      "daysToDeadline": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.openlens.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Clerk API key. Create one from your account settings under API Keys.

Query Parameters

projectId
string<uuid>
required

Project id. Required on all data endpoints.

includeArchived
boolean
default:false

Response

Successful response

workstreams
object[]
required