Risk Cloud API: Record Search

Updated on: October 31, 2023

From field values to due dates, the Risk Cloud’s Record API enables you to export and process your record data via the Risk Cloud API.

Additionally, API users can filter records by application, workflow, step, and even when records were last updated.

Obtain your API Access Token or pull the Risk Cloud Postman Collection to get started.

Retrieve Records Endpoint

The Record API offers the following Retrieve Records endpoint which 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, however 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 API integration has permission set entitlements in place to read or write every step of the workflow or application.

GET/api/v2/records

This endpoint has the following optional query parameters for additional filtering.

Query Parameter Description
application-id The unique ID of an application where, if provided, the response will only contain records from the identified application.
workflow-id The unique ID of a workflow where, if provided, the response will only contain records from the identified workflow.
step-id The unique ID of a step where, if provided, the response will only contain records on the identified step.
updated-min A timestamp measured in milliseconds since the Unix epoch where, if provided, the response will only contain records that have been modified since the given timestamp.
page The zero-indexed page number (must not be less than 0, defaults to 0).
size The size of the page and maximum number of items to be returned (must not be less than 1, defaults to 20).

Use Cases

Records by Application

To request all records in an application, use the application-id query parameter with the ID of the application.

GET/api/v2/records?application-id={application-id}

The application ID can be obtained from either your Risk Cloud web app environment directly or from the Risk Cloud API.

Get Application ID (Web App Environment)

The application ID can be located within your Risk Cloud web app environment in the following location:

  • Navigate to Build > Applications
  • Search for and open the application
  • The application ID can be found in the web browser URL bar https://environment.logicgate.com/build/applications/{application-id}

Get Application ID (Risk Cloud API)

The application ID can be located via the Retrieve Applications endpoint, specifically in the id property of application objects returned in the content property of the response.

GET/api/v2/applications

Records by Workflow

To request all records in a workflow, use the workflow-id query parameter with the ID of the workflow.

GET/api/v2/records?workflow-id={workflow-id}

The workflow ID can be obtained from either your Risk Cloud web app environment directly or from the Risk Cloud API.

Get Workflow ID (Web App Environment)

The workflow ID can be located within your Risk Cloud web app environment in the following location:

  • 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

Get Workflow ID (Risk Cloud API)

The workflow ID can be located via the Retrieve Workflows endpoint, specifically in the id property of workflow objects returned in the content property of the response.

GET/api/v2/workflows

Records by Step

To request all records on a step, use the step-id query parameter with the ID of the step.

GET/api/v2/records?step-id={step-id}

The step ID can be obtained from either your Risk Cloud web app environment directly or from the Risk Cloud API.

Get Step ID (Web App Environment)

The step ID can be located within your Risk Cloud web app environment in the following location:

  • 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 web browser URL bar https://environment.logicgate.com/build/steps/{step-id}

Get Step ID (Risk Cloud API)

The step ID can be located via the Retrieve Steps endpoint, specifically in the id property of step objects returned in the content property of the response.

GET/api/v2/steps

Records Updated Since Date

To request all records that have been updated (either a field has been updated or the record has been moved, assigned, or linked), use the updated-min query parameter with a timestamp measured in milliseconds since the Unix epoch. An example for January 1st 2023 at 9:00am GMT would be 1672563600000.

The updated-min query parameter can additionally be used alongside other query parameter filters such as application-id, workflow-id, and step-id to fine-tune your record search further.

GET/api/v2/records?updated-min={updated-min}

Retrieve Records by Field Value Endpoint

The Record API also provides the ability to return records that have a particular field value. This can be accomplished with the following v1 API endpoint and query parameters.

GET/api/v1/records?field={field-id}&textValue={text-value}
Query Parameter Description
field The unique ID of the field for the associated text value to filter records by.
textValue The text value of the given field to filter records by.