Training Modules

Training planner grid

Every training against every person on the roster, most urgent first. Unlike the analytics endpoints, this includes people who have never attempted a training — which is the only way to see who still has not done one.

Scope: modules:read

get/v1/modules/planner

Request

  • Base URL: https://api.vidocu.ai
  • URL: https://api.vidocu.ai/v1/modules/planner
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://vidocu.ai/oauth/authorize, token URL https://api.vidocu.ai/oauth/token)

Query parameters

pageinteger
limitinteger
moduleIdstring
emailstring
status'passed' | 'renewed' | 'expired' | 'awaiting_signoff' | 'in_progress' | 'not_started' | 'revoked' | 'blocked'
overdueboolean
mandatoryboolean
readiness'all' | 'approved' | 'published'
string
OR
string[]
string
OR
string[]
applicability'undecided' | 'applicable' | 'not_applicable'
includeNaboolean
includeArchivedboolean
searchstring
sort'urgency' | 'training' | 'person' | 'status' | 'expires' | 'deadline'
dir'asc' | 'desc'

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.