COcortex
Initiatives

List Initiatives

Retrieves a list of Initiatives.

API key must have the View Initiatives permission.

get/api/v1/initiatives

Request

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

Query parameters

includeDraftsboolean

Whether or not to include draft Initiatives in the response

includeExpiredboolean

Whether or not to include expired Initiatives in the response

pageSizeinteger required

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

pageinteger required

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

Response

Successfully retrieved Initiatives

pageinteger required

Current page number, 0-indexed

totalinteger required

Total number of results

totalPagesinteger required

Total number of pages

Example response

{
  "initiatives": [
    {
      "cid": "in2da8159dbeefb974"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.