Initiative

List Initiatives

This endpoint retrieves a list of Initiatives ordered by creation date (oldest first) and limited to 20 items per page.

Alignments:

  • supports shows what Strategic Elements, Goals, Key Results, Initiatives, or KPIs this Initiative contributes to
  • supported_by shows what Strategic Elements, KPIs, Goals or Initiatives support this Initiative
  • Empty arrays are omitted from the response
get/initiatives

Request

  • Base URL: https://connect.workpath.com/api/v3
  • URL: https://connect.workpath.com/api/v3/initiatives
  • Auth: HTTP bearer

Query parameters

pageinteger
Example:1

The page you want to request. First page will be returned if omitted or invalid.

start_datestring date
Example:2026-01-01

Return only Initiatives whose start and target dates overlap with the range start_date to end_date. Both parameters must be passed together. Initiatives without a start or target date are excluded.

end_datestring date
Example:2026-03-31

Return only Initiatives whose start and target dates overlap with the range start_date to end_date. Both parameters must be passed together. Initiatives without a start or target date are excluded.

external_idstring
Example:a1b2c3d4

Filter by external_id (exact match).

Response

OK

idinteger required

Unique identifier for the Initiative.

titlestring required

Title of the Initiative.

descriptionstring nullable required

Detailed description of the Initiative.

status'not_started' | 'in_progress' | 'in_danger' | 'done' | 'failed' required

Current status of the Initiative:

  • not_started: Work has not begun
  • in_progress: Work is underway
  • in_danger: Delivery is at risk
  • done: Successfully completed
  • failed: Did not complete successfully
progressnumber nullable required

Overall progress of the Initiative, expressed as a decimal between 0 and 1. null when progress tracking is disabled on the Initiative; 0 when tracking is enabled but no progress update has set a value yet.

start_datestring date nullable required

Planned start date of the Initiative in ISO 8601 format.

target_datestring date nullable required

Target completion date of the Initiative in ISO 8601 format.

external_idstring nullable required

Identifier of the same item in another system, for example a Jira issue key. Workpath stores it without interpreting it, so you can match Initiatives to records in your own tools.

created_atstring date-time required

Timestamp when the Initiative was created in ISO 8601 format.

updated_atstring date-time required

Timestamp when the Initiative was last updated in ISO 8601 format.

workpath_urlstring uri required

URL to view the Initiative in the Workpath platform.

confidence_levelinteger nullable

Confidence level of the Initiative (1-10). null when nobody has set one. Independent of progress tracking, so it is returned even when progress is disabled.

Example response

[
  {
    "id": 7,
    "title": "Roll out OKR training program to all teams",
    "description": "Train every team lead in writing and reviewing OKRs before the Q2 planning cycle.",
    "status": "in_progress",
    "progress": 0.4,
    "confidence_level": 7,
    "start_date": "2026-01-01",
    "target_date": "2026-03-31",
    "external_id": "a1b2c3d4",
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-02-20T14:45:00Z",
    "workpath_url": "https://acme.workpath.com/initiatives/7",
    "owners": {
      "users": [
        {
          "id": 8,
          "name": "Elena Fischer"
        }
      ],
      "teams": [
        {
          "id": 6,
          "name": "People & Culture"
        }
      ]
    },
    "supports": {
      "goals": [
        {
          "id": 42,
          "title": "Successfully implement the strategic operating model across the organization"
        }
      ],
      "key_results": [
        {
          "id": 12,
          "title": "Teams have drafted their quarterly goals"
        }
      ]
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.