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

includeDraftsbooleanOptional

Whether or not to include draft Initiatives in the response

Default: false

includeExpiredbooleanOptional

Whether or not to include expired Initiatives in the response

Default: false

pageSizeinteger · int32Required

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

Default: 250

pageinteger · int32Required

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

Default: 0

Responses

200

Successfully retrieved Initiatives

application/json

429

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

application/problem+json

get

HTTPcURLJavaScriptPython

GET /api/v1/initiatives HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "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-05-16"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Get Initiative

get

Get Initiative.

API key must have the View Initiatives permission.

Authorizations

Path parameters

cidstringRequired

Responses

200

Successfully retrieved Initiative

application/json

404

Initiative not found

application/json

429

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

application/problem+json

get

HTTPcURLJavaScriptPython

GET /api/v1/initiatives/{cid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "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-05-16"
}

Create an Initiative

post

Create an Initiative.

API key must have the Edit Initiative permission.

Authorizations

Body

descriptionstringOptional

Optional description of the Initiative

isDraftbooleanRequired

Whether or not the Initiative is a draft

namestringRequired

Name of 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

200

Successfully created Initiative

application/json

400

Bad Request

application/json

429

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

application/problem+json

post

HTTPcURLJavaScriptPython

POST /api/v1/initiatives HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "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-05-16"
}

{
  "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-05-16"
}

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

isDraftbooleanRequired

Whether or not the Initiative is a draft

namestringRequired

Name of 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

200

Successfully updated Initiative

application/json

400

Bad Request

application/json

404

Initiative not found

application/json

429

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

application/problem+json

put

HTTPcURLJavaScriptPython

PUT /api/v1/initiatives/{cid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "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-05-16"
}

{
  "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-05-16"
}

Delete Initiative

delete

Authorizations

Path parameters

cidstringRequired

Responses

200

Successfully deleted Initiative

404

Initiative not found

application/json

429

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

application/problem+json

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/initiatives/{cid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content