Skip to main content
GET
Retrieve a verification period

Authorizations

Authorization
string
header
required

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path Parameters

periodCid
string
required

The CID of the verification period

Response

The verification period

A verification period and how far along it is

cid
string
required

Stable identifier, usable wherever a period CID is accepted

Example:

"vp0a1b2c3d4e5f6789"

counts
object
required

Entity counts for one verification period

endDate
string<date-time>
required

When the period closes

isActive
boolean
required

Whether the period is open today, and so still accepting verifications

Example:

true

name
string
required

Display name

Example:

"Q3 Ownership Review"

reasonRequired
boolean
required

Whether a reason is required when an entity is marked incorrect

Example:

false

requiredCustomRoleTags
string[]
required

Tags of custom Cortex roles a user must hold to verify

Tags of custom Cortex roles a user must hold to verify

requiredRoles
enum<string>[]
required

Cortex roles a user must hold to verify

Cortex roles a user must hold to verify. Empty means any owner of the entity may verify.

Available options:
VIEWER,
USER,
MANAGER,
API,
OWNER
Example:
requiredTeamRoleTags
string[]
required

Tags of team roles a user must hold on an owning team to verify

Tags of team roles a user must hold on an owning team to verify

scope
object
required

Which entities a verification period covers. An empty scope covers every entity. Combined conditions all have to hold.

startDate
string<date-time>
required

When the period opens

description
string

What owners are being asked to confirm

Last modified on September 29, 2026