Initiatives

Use these operations to interact with Initiatives in Cortex.

Required permissions

• Create, read, update, or delete Initiatives: Your API key must have the Edit Initiatives permission.

• View Initiatives: Your API key must have the View Initiatives permission.

Operations

List Initiatives

get

Retrieves a list of Initiatives.

API key must have the View Initiatives permission.

Authorizations

Query parameters

includeDraftsboolean · default: falseoptional

Whether or not to include draft Initiatives in the response

includeExpiredboolean · default: falseoptional

Whether or not to include expired Initiatives in the response

pageSizeinteger · int32 · default: 250required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger · int32 · default: 0required

Page number to return, 0-indexed. Default 0.

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/initiatives?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

429

200

{
  "initiatives": [
    {
      "cid": "in2da8159dbeefb974",
      "description": "text",
      "emphasizedLevels": [
        {
          "color": "text",
          "name": "text",
          "rank": 1
        }
      ],
      "emphasizedRules": [
        {
          "description": "text",
          "expression": "text",
          "title": "text"
        }
      ],
      "filter": {
        "groups": {
          "exclude": [
            "text"
          ],
          "include": [
            "text"
          ]
        },
        "query": "text",
        "types": {
          "exclude": [
            "text"
          ],
          "include": [
            "text"
          ]
        }
      },
      "isDraft": true,
      "name": "text",
      "notificationSchedule": {
        "isDisabled": true,
        "replyToEmails": [
          "text"
        ],
        "timeInterval": 1,
        "timeUnit": "text"
      },
      "scorecardName": "text",
      "scorecardTag": "text",
      "targetDate": "2025-03-31"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Successfully retrieved Initiatives

Get Initiative

get

Get Initiative.

API key must have the View Initiatives permission.

Authorizations

Path parameters

cidstringrequired

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/initiatives/{cid}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "cid": "in2da8159dbeefb974",
  "description": "text",
  "emphasizedLevels": [
    {
      "color": "text",
      "name": "text",
      "rank": 1
    }
  ],
  "emphasizedRules": [
    {
      "description": "text",
      "expression": "text",
      "title": "text"
    }
  ],
  "filter": {
    "groups": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    },
    "query": "text",
    "types": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    }
  },
  "isDraft": true,
  "name": "text",
  "notificationSchedule": {
    "isDisabled": true,
    "replyToEmails": [
      "text"
    ],
    "timeInterval": 1,
    "timeUnit": "text"
  },
  "scorecardName": "text",
  "scorecardTag": "text",
  "targetDate": "2025-03-31"
}

Successfully retrieved Initiative

Create an Initiative

post

Create an Initiative.

API key must have the Edit Initiative permission.

Authorizations

Body

descriptionstringoptional

Optional description of the Initiative

emphasizedLevelsobject[]required

Emphasized levels for the Initiative. Either emphasized levels or rules must be provided

emphasizedRulesobject[]required

Emphasized rules for the Initiative. Either emphasized levels or rules must be provided

filterobjectoptional

Filter applied to the Initiative

isDraftbooleanrequired

Whether or not the Initiative is a draft

namestringrequired

Name of the Initiative

notificationScheduleobjectoptional

Notification schedule for the Initiative

scorecardTagstringrequired

Tag of the scorecard associated with the Initiative

targetDatestring · daterequired

Target date for the Initiative to be completed. Must be in the future

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/initiatives' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "text",
    "emphasizedLevels": [
      {
        "rank": 1
      }
    ],
    "emphasizedRules": [
      {
        "expression": "text"
      }
    ],
    "filter": {
      "groups": {
        "exclude": [
          "text"
        ],
        "include": [
          "text"
        ]
      },
      "query": "text",
      "types": {
        "exclude": [
          "text"
        ],
        "include": [
          "text"
        ]
      }
    },
    "isDraft": true,
    "name": "text",
    "notificationSchedule": {
      "isDisabled": true,
      "replyToEmails": [
        "text"
      ],
      "timeInterval": 1,
      "timeUnit": "text"
    },
    "scorecardTag": "text",
    "targetDate": "2025-03-31"
  }'

200

400

429

200

{
  "cid": "in2da8159dbeefb974",
  "description": "text",
  "emphasizedLevels": [
    {
      "color": "text",
      "name": "text",
      "rank": 1
    }
  ],
  "emphasizedRules": [
    {
      "description": "text",
      "expression": "text",
      "title": "text"
    }
  ],
  "filter": {
    "groups": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    },
    "query": "text",
    "types": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    }
  },
  "isDraft": true,
  "name": "text",
  "notificationSchedule": {
    "isDisabled": true,
    "replyToEmails": [
      "text"
    ],
    "timeInterval": 1,
    "timeUnit": "text"
  },
  "scorecardName": "text",
  "scorecardTag": "text",
  "targetDate": "2025-03-31"
}

Successfully created Initiative

Update an Initiative

put

Update an Initiative.

API key must have the Edit Initiative permission.

Authorizations

Path parameters

cidstringrequired

Body

descriptionstringoptional

Optional description of the Initiative

emphasizedLevelsobject[]required

Emphasized levels for the Initiative. Either emphasized levels or rules must be provided

emphasizedRulesobject[]required

Emphasized rules for the Initiative. Either emphasized levels or rules must be provided

filterobjectoptional

Filter applied to the Initiative

isDraftbooleanrequired

Whether or not the Initiative is a draft

namestringrequired

Name of the Initiative

notificationScheduleobjectoptional

Notification schedule for the Initiative

scorecardTagstringrequired

Tag of the scorecard associated with the Initiative

targetDatestring · daterequired

Target date for the Initiative to be completed. Must be in the future

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/initiatives/{cid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "text",
    "emphasizedLevels": [
      {
        "rank": 1
      }
    ],
    "emphasizedRules": [
      {
        "expression": "text"
      }
    ],
    "filter": {
      "groups": {
        "exclude": [
          "text"
        ],
        "include": [
          "text"
        ]
      },
      "query": "text",
      "types": {
        "exclude": [
          "text"
        ],
        "include": [
          "text"
        ]
      }
    },
    "isDraft": true,
    "name": "text",
    "notificationSchedule": {
      "isDisabled": true,
      "replyToEmails": [
        "text"
      ],
      "timeInterval": 1,
      "timeUnit": "text"
    },
    "scorecardTag": "text",
    "targetDate": "2025-03-31"
  }'

200

400

404

429

200

{
  "cid": "in2da8159dbeefb974",
  "description": "text",
  "emphasizedLevels": [
    {
      "color": "text",
      "name": "text",
      "rank": 1
    }
  ],
  "emphasizedRules": [
    {
      "description": "text",
      "expression": "text",
      "title": "text"
    }
  ],
  "filter": {
    "groups": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    },
    "query": "text",
    "types": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    }
  },
  "isDraft": true,
  "name": "text",
  "notificationSchedule": {
    "isDisabled": true,
    "replyToEmails": [
      "text"
    ],
    "timeInterval": 1,
    "timeUnit": "text"
  },
  "scorecardName": "text",
  "scorecardTag": "text",
  "targetDate": "2025-03-31"
}

Successfully updated Initiative

Delete Initiative

delete

Authorizations

Path parameters

cidstringrequired

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/initiatives/{cid}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

No body

Successfully deleted Initiative