Skip to Content

POST /department/export

Export Departments

Export all departments as a clean, denormalized CSV.

Request Body (ExportDepartmentApiRequest)

FieldTypeRequiredDescription
department_idstringNoUUID of the department to export
idempotency_keystringNoIdempotency key — replays the prior export instead of re-running
softbooleanNoStage the export dormant (active=False); ack with accept activates it
acceptbooleanNoAck: True promotes the staged export, False rejects. Only meaningful with idempotency_key

Response (ExportDepartmentApiResponse)

FieldTypeRequiredDescription
file_idstringYesUUID of the files_resource holding the export CSV
file_namestringYesSuggested download file name
row_countintegerYesNumber of data rows in the export
idempotency_keystringNoServer-minted soft-call key (audit call_id). On a soft propose, echo this back with accept to promote/reject the staged export.
Last updated on