Skip to main content
This guide walks through exporting Record data in CSV or XLSX format using the Risk Cloud API.

​
Authentication

Obtain your API Access Token before getting started — see Authentication.

​
Overview

Exporting Records is a four-step process:
  1. Obtain the layout-id that defines which columns are included in the export.
  2. Obtain the application-id, workflow-id, and (optionally) step-id that define which Records to export.
  3. Optionally choose one or more status filters.
  4. Submit the export request and retrieve the file.

​
Step 1: Obtain the layout-id

The Layout ID can be found in the URL of the Layout Builder:
Alternatively, retrieve it via the API:

​
Step 2: Obtain the application-id, workflow-id, and step-id

Application and Step IDs can also be found in their respective Builder URLs:
Or retrieve them via the API:

​
Step 3: Select status filters (optional)

You can restrict the export to Records in specific statuses:
  • INACTIVE
  • NOT_ASSIGNED
  • ASSIGNED
  • IN_PROGRESS
  • COMPLETE

​
Step 4: Retrieve the record export

Submit the IDs gathered above to the export endpoint:
Swap csv for xlsx in the path to receive an Excel file instead.
The response is a CSV or XLSX representation of the matching Records, with field columns reflecting the provided layout.

​
Next steps

To find Records to export without walking through the Builder UI, see Record Search. The application, workflow, and step lookup endpoints above are paginated — see Pagination if you need to page through large result sets.