Kpis API: Get kpi

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/kpis/get_kpi
Handler	OperatelyWeb.Api.Kpis.GetKpi

Authentication#

• Requires a valid API token.
• Read-only and full-access tokens can execute this query.

Inputs#

Field	Type	Required	Nullable	Default
kpi_id	id primitive (encoded as string)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
kpi	kpi object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/kpis/get_kpi?kpi_id=value" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "kpi": {
    "__typename": "value",
    "annotations": [
      "<kpi_annotation>"
    ],
    "cadence": "value",
    "champion": "<person>",
    "description": "value",
    "entries": [
      "<kpi_entry>"
    ],
    "id": "value",
    "inserted_at": "2026-01-01T09:30:00Z",
    "latest_entry": "<kpi_entry>",
    "name": "value",
    "space_id": "value",
    "subscription_list": "<subscription_list>",
    "unit": "value",
    "updated_at": "2026-01-01T09:30:00Z"
  }
}