COcortex
Verifications

Retrieve verification periods

Changed on

Returns every verification period in the workspace, open or closed, with a count of how many entities are outstanding.

get/api/v1/verification-periods

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/verification-periods
  • Auth
    HTTP bearer

Query parameters

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.

isActiveboolean

Return only periods that are open today (true) or only those that are not (false). Omit for all periods.

Response

All verification periods

pageinteger required

Current page number, 0-indexed

totalinteger required

Total number of results

totalPagesinteger required

Total number of pages

Example response

{
  "periods": [
    {
      "cid": "vp0a1b2c3d4e5f6789",
      "counts": {
        "pending": 12,
        "verifiedCorrect": 40,
        "verifiedIncorrect": 3
      },
      "isActive": true,
      "name": "Q3 Ownership Review",
      "requiredRoles": [
        "OWNER"
      ],
      "scope": {
        "cqlQuery": "tag != null",
        "types": [
          "service"
        ]
      }
    }
  ]
}

Changes