Skip to main content
From field values to due dates, the Record API enables you to export and process your record data via the Risk Cloud API. API users can filter records by application, workflow, step, and even by when records were last updated. Obtain your API Access Token or pull the Risk Cloud Postman Collection (see the Postman guide) to get started.

​
Retrieve Records endpoint

This endpoint returns an iterable page of all records that the current user has read or write access to. The Records API is available to all authenticated users, but it only returns records that are entitled to be read by the user whose API token is being used for the request. Entitlement is based on any of the following being true:
  • The user has a read or write step permission set entitlement to the step.
  • The user is assigned to the record.
To retrieve all record data from a particular workflow or application, ensure that the user whose API token is being used for the integration has permission set entitlements in place to read or write every step of the workflow or application. This endpoint accepts the following optional query parameters for additional filtering: See Pagination for details on the page/size parameters and the response envelope.

​
Use cases

​
Records by application

The application ID can be obtained from the Risk Cloud web app or from the API. Web app environment:
  • Navigate to Build > Applications.
  • Search for and open the application.
  • The application ID can be found in the browser URL bar: https://environment.logicgate.com/build/applications/{application-id}.
Risk Cloud API:
The application ID can be located in the id property of application objects returned in the content property of the response.

​
Records by workflow

The workflow ID can be obtained from the Risk Cloud web app or from the API. Web app environment:
  • Navigate to Build > Applications.
  • Search for and open the application containing the workflow.
  • Open the edit gear icon (⚙) on the workflow to open the Workflow Editor.
  • The workflow ID can be found under the Workflow ID label in the editor window.
Risk Cloud API:
The workflow ID can be located in the id property of workflow objects returned in the content property of the response.

​
Records by step

The step ID can be obtained from the Risk Cloud web app or from the API. Web app environment:
  • Navigate to Build > Applications.
  • Search for and open the application containing the step.
  • Open the workflow containing the step.
  • The step ID can be found in the browser URL bar: https://environment.logicgate.com/build/steps/{step-id}.
Risk Cloud API:
The step ID can be located in the id property of step objects returned in the content property of the response.

​
Records updated since date

To request all records that have been updated (a field was updated, or the record was moved, assigned, or linked), use the updated-min query parameter with a timestamp measured in milliseconds since the Unix epoch. For example, January 1st 2023 at 9:00am GMT is 1672563600000.
The updated-min parameter can be combined with application-id, workflow-id, and step-id to narrow your record search further.

​
Retrieve Records by Field Value endpoint

The Record API also provides the ability to return records that have a particular field value, using the following v1 endpoint:
There are two main ways to search for records by field and value: by text value or by numeric value. Which one you use depends on the field you are searching. By default, use the textValue query parameter. If you’re searching a Number Field, use the numericValue query parameter instead.