Skip to content

Enums ​

Reference tables for all enumerated field values used across the API.


Project status ​

ValueMeaning
activeProject is live and receiving monthly reports
pendingProject set up but not yet started
pending - in progressSetup in progress
pausedTemporarily paused
endedProject has ended
termination pendingScheduled to end

Report status ​

Field name note: /reports and /reports/latest expose this as status. The content endpoint (/reports/{report_number}/content) exposes the same values as generation_status. The wire values are identical.

ValueMeaning
pendingReport scheduled but not yet started
runningContent is being generated
completedContent generation finished - ready to fetch
failedGeneration failed

Report approved_status ​

ValueMeaning
waitingAwaiting review
on-holdReview paused
approvedApproved and ready to publish
blockedBlocked pending resolution
nullNot yet set

Report managed_status ​

ValueMeaning
in-progressBeing worked on
on-holdPaused
completedManagement workflow complete
waiting-on-clientBlocked on client action
nullNot yet set

Token status ​

ValueMeaning
activeToken is valid and usable
disabledToken has been deactivated