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
Retrieves a list of Initiatives.
API key must have the View Initiatives
permission.
Whether or not to include draft Initiatives in the response
false
Whether or not to include expired Initiatives in the response
false
Number of results to return per page, between 1 and 1000. Default 250.
250
Page number to return, 0-indexed. Default 0.
0
Successfully retrieved Initiatives
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
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-09-16"
}
],
"page": 1,
"total": 1,
"totalPages": 1
}
Get Initiative.
API key must have the View Initiatives
permission.
Successfully retrieved Initiative
Initiative not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
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-09-16"
}
Create an Initiative.
API key must have the Edit Initiative
permission.
Optional description of the Initiative
Whether or not the Initiative is a draft
Name of the Initiative
Tag of the scorecard associated with the Initiative
Target date for the Initiative to be completed. Must be in the future
Successfully created Initiative
Bad Request
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
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-09-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-09-16"
}
Update an Initiative.
API key must have the Edit Initiative
permission.
Optional description of the Initiative
Whether or not the Initiative is a draft
Name of the Initiative
Tag of the scorecard associated with the Initiative
Target date for the Initiative to be completed. Must be in the future
Successfully updated Initiative
Bad Request
Initiative not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
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-09-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-09-16"
}
Successfully deleted Initiative
No content
Initiative not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/initiatives/{cid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Last updated
Was this helpful?