Skip to content
Proud to collaborate with Microsoft for Startups

audit.audit-run.get ​

Get one audit scan run for an organization.

Fetch one audit run, scoped to the caller organization.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-audit
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization whose audit runs are queried
audit_run_uuiduuidYes——
include_deletedbooleanNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
audit_run_uuiduuidNo——
audit_runjsonNo——
foundbooleanYes——
mismatchbooleanYes——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

Outcomes ​

OutcomeTypeDescriptionState Data Keys
readSUCCESSAudit run returnedaudit_run_uuid, found
failedFAILUREAudit workflow failedfailure_reason

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "audit.audit-run.get",
  "initial_data": {
    "organization_uuid": "value",
    "audit_run_uuid": "value"
  }
}