Appearance
Enums
Reference tables for all enumerated field values used across the API.
Project status
| Value | Meaning |
|---|---|
active | Project is live and receiving monthly reports |
pending | Project set up but not yet started |
pending - in progress | Setup in progress |
paused | Temporarily paused |
ended | Project has ended |
termination pending | Scheduled to end |
Report status
Field name note:
/reportsand/reports/latestexpose this asstatus. The content endpoint (/reports/{report_number}/content) exposes the same values asgeneration_status. The wire values are identical.
| Value | Meaning |
|---|---|
pending | Report scheduled but not yet started |
running | Content is being generated |
completed | Content generation finished - ready to fetch |
failed | Generation failed |
Report approved_status
| Value | Meaning |
|---|---|
waiting | Awaiting review |
on-hold | Review paused |
approved | Approved and ready to publish |
blocked | Blocked pending resolution |
null | Not yet set |
Report managed_status
| Value | Meaning |
|---|---|
in-progress | Being worked on |
on-hold | Paused |
completed | Management workflow complete |
waiting-on-client | Blocked on client action |
null | Not yet set |
Token status
| Value | Meaning |
|---|---|
active | Token is valid and usable |
disabled | Token has been deactivated |