COcortex
Initiatives

Get Initiative

Changed on

Get Initiative.

API key must have the View Initiatives permission.

get/api/v1/initiatives/{cid}

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/initiatives/{cid}
  • Auth
    HTTP bearer

Path parameters

cidstring required

Response

Successfully retrieved Initiative

cidstring

Unique, immutable, 18-character auto-generated identifier for the Initiative.

dateCreatedstring date-time required

Time the Initiative was created

dateUpdatedstring date-time required

Time the Initiative was last updated

descriptionstring

Optional description of the Initiative

isDraftboolean required

Whether or not the Initiative is a draft

namestring required

Name of the Initiative

scorecardNamestring required

Name of the scorecard associated with the Initiative

scorecardTagstring required

Tag of the scorecard associated with the Initiative

targetDatestring date required

Target date for the Initiative to be completed

Example response

{
  "cid": "in2da8159dbeefb974"
}

Changes