KPI

List KPIs

This endpoint retrieves the active KPIs visible to the API client, ordered by creation date (oldest first) and limited to 20 items per page.

get/kpis

Request

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

Query parameters

pageinteger
Example:3

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

Response

OK

idinteger

Unique identifier for the KPI.

titlestring

Concise, descriptive name of the KPI that highlights its primary focus or measurement.

kind'organization' | 'team' | 'business_unit'

Whether the KPI belongs to the whole organization (organization), a Business Unit (business_unit) or a team (team).

descriptionstring

A brief explanation of the KPI, providing context and relevance to its purpose or measurement.

external_idstring nullable

External system identifier for integration purposes.

decimal_placesinteger nullable

Number of decimal places the KPI value is shown with (0-10). null uses the default.

target_type'above' | 'below'

Whether higher values are better (above: the aim is to reach or exceed the target) or lower values are better (below: the aim is to stay at or under the target).

workpath_urlstring uri

URL to view the KPI in the Workpath platform.

created_atstring date-time

Timestamp when the KPI was created in ISO 8601 format.

updated_atstring date-time

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

Example response

[
  {
    "id": 10,
    "title": "Product Users: Quarterly Active Users Growth Rate.",
    "description": "Users that were online within the last 90 days, year over year.",
    "kind": "team",
    "target_type": "above",
    "external_id": "KPI-QAU-001",
    "decimal_places": 2,
    "created_at": "2025-06-15T10:30:00Z",
    "updated_at": "2026-03-02T09:15:00Z",
    "workpath_url": "https://acme.workpath.com/goals/overview/teams/23?selectedKpiId=10#kpis",
    "type": {
      "name": "percental"
    },
    "team": {
      "id": 23,
      "name": "Product Growth"
    },
    "owners": {
      "teams": [
        {
          "id": 23,
          "name": "Product Growth"
        }
      ]
    },
    "current_actual": {
      "value": 15.12,
      "date": "2026-03-01",
      "status": "On Track",
      "summary": "All looking good so far.",
      "status_color": "success"
    },
    "current_target": {
      "value": 40,
      "date": "2026-06-30"
    },
    "current_forecast": {
      "value": 42.43,
      "date": "2026-06-30"
    },
    "supports": {
      "kpis": [
        {
          "id": 8,
          "title": "Annual Recurring Revenue (ARR)"
        }
      ]
    },
    "supported_by": {
      "goals": [
        {
          "id": 55,
          "title": "Grow our user base by 50% this year"
        }
      ],
      "initiatives": [
        {
          "id": 12,
          "title": "Launch referral program for existing users"
        }
      ]
    }
  }
]

Changes

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