Get the auditable entities with their associated data such as files, issues, risk scores, and users.

Note: Use the url property of a file in the files array to get entity files.

External Documentation

To learn more, visit the AuditBoard documentation.

​
Parameters

ParameterDescription
IncludeSpecify which optional data fields to include in the response.

​
Example Output

{
  "auditable_entities": [
    {
      "id_string": "My Vendor! (uid: 150)",
      "custom_date1": null,
      "custom_date2": null,
      "custom_date3": null,
      "custom_date4": null,
      "effective_date": null,
      "prior_audit_final_report_date": null,
      "risk_next_audit_due_date": null,
      "regulatory_next_audit_due_date": null,
      "id": 150,
      "uid": "150",
      "name": "My Vendor!",
      "file_ids": [
        1878
      ],
          }
  ],
  "files": [
    {
      "viewable_link": null,
      "url": "https://<your-subdomain>.auditboardapp.com/soxhubuploads/soxhubuploads/7cfefc5c-f7b6-42ea-964f-5cc25e631043/foo?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=soxhub_minio_key%2F20230328%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230328T190830Z&X-Amz-Expires=3600&X-Amz-Signature=04624d41ab55371dd05284fe4c3571b7833cee9e56043d2232b5fd7184799807&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D%22foo%22%3B%20filename%2A%3Dutf-8%27%27foo",
      "image_url": "",
      "id": 1878,
//...
    }
  ],
 "issues": [
    {
      "last_action_plan_due_date": null,
      "alias_reference_issue_id": null,
      "alias_controls_datum_id": null,
      "alias_compliance_assessment_item_id": null,
      "alias_ops_audit_item_id": null,
      "alias_test_id": null,
      "linkify_uid": "I#347",
      "remediation_owners": {
        "all": []
      },
      "identified_date": null,
      "custom_date1": null,
      "custom_date2": null,
      "custom_date3": null,
      "custom_date4": null,
      "external_planned_confirm_date": null,
      "external_confirm_date": null,
      "internal_audit_validation_date": null,
      "id": 347,
      "status": "Inactive",
      // ...
      "title": "My Issue for My Vendor",
      "description": "",
      // ...
      }
  ]
}

​
Workflow Library Example

List Auditable Entities with Auditboard and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?

Get UsersList Auditable Entity Types