---
title: "List Initiatives"
method: GET
path: "/api/v1/initiatives"
tags: ["Initiatives"]
---

# List Initiatives

`GET /api/v1/initiatives`

Retrieves a list of Initiatives.

API key must have the `View Initiatives` permission.

## Query parameters

- `includeDrafts` boolean
- `includeExpired` boolean
- `pageSize` integer, required
- `page` integer, required

## Response `200`

Successfully retrieved Initiatives

- InitiativeListResponse
  - `initiatives` Initiative[], required
    - `cid` string — Unique, immutable, 18-character auto-generated identifier for the Initiative.
    - `dateCreated` string, date-time, required — Time the Initiative was created
    - `dateUpdated` string, date-time, required — Time the Initiative was last updated
    - `description` string — Optional description of the Initiative
    - `emphasizedLevels` EmphasizedLevel[], required — Emphasized levels for the Initiative
      - `color` string, required — Color associated with the emphasized level
      - `name` string, required — Name of the emphasized level
      - `rank` integer, required — Rank of the level where 1 is the highest
    - `emphasizedRules` EmphasizedRule[], required — Emphasized rules for the Initiative
      - `description` string — Optional description of the emphasized rule
      - `expression` string, required — CQL expression for the emphasized rule
      - `title` string — Optional title of the emphasized rule
    - `filter` Filter — Filter applied to the Initiative
      - `groups` GroupFilter — Entity groups to include or exclude
        - `exclude` string[]
        - `include` string[]
      - `query` string — CQL expression to apply as a filter
      - `types` TypeFilter — Entity types (e.g. service, domain, team) to include or exclude. Only one of `include` or `exclude` can be set
        - `exclude` string[]
        - `include` string[]
    - `isDraft` boolean, required — Whether or not the Initiative is a draft
    - `name` string, required — Name of the Initiative
    - `notificationSchedule` NotificationSchedule — Notification schedule for the Initiative
      - `isDisabled` boolean, required — Whether or not notifications are disabled for this Initiative
      - `replyToEmails` string[] — Optional list of reply-to emails
      - `timeInterval` integer, required — Time interval for the notification schedule cadence
      - `timeUnit` string, required — Time unit for the notification schedule. Must be one of DAY, WEEK, MONTH
    - `scorecardName` string, required — Name of the scorecard associated with the Initiative
    - `scorecardTag` string, required — Tag of the scorecard associated with the Initiative
    - `targetDate` string, date, required — Target date for the Initiative to be completed
  - `page` integer, required — Current page number, 0-indexed
  - `total` integer, required — Total number of results
  - `totalPages` integer, required — Total number of pages

## Other responses

- `429` — The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

---

[API](https://skmtc.dev/cortex/apis/cortex-api.md) · [All operations](https://skmtc.dev/cortex/apis/cortex-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cortex/cortex-api/revisions/141799a965b4/schema)