List Records - BlinkOps Documentation

List all the records in your Ironclad company. Required OAuth scope: public.records.readRecords

External DocumentationTo learn more, visit the Ironclad documentation.

Basic Parameters

Parameter	Description
Filter	A formula to filter the records by. Enclose the record property ID in brackets and the value in single quotes. You can get the available record properties using the `List Records Metadata` action. For Example: `Equals([counterpartyName], 'Test LLC')` For all the supported formula operations, refer to Ironclad documentation.
Last Updated	The date and time to return only the records that were updated since it.
Page	The number of the page to return results from. The first page is `0`.
Page Size	The maximum number of results to return per page. Values can range from `1` to `100`.
Return All Pages	Automatically fetch all resources, page by page.
Search	A free-text search across all the record properties, matching the in-app search. Maximum is 1000 characters.
Sort Direction	Select the direction to sort the results in.
Sort Field	Select the field to sort the results by.
Types	A comma-separated list of the record types to return, with no spaces. You can get the available record types using the `List Records Metadata` action. For Example: `mutualNDA,consultingAgreement`

Advanced Parameters

Parameter	Description
Address As Object	Select to return address properties as objects instead of strings.
Hydrate Entities	Select to fully hydrate the related entities instead of returning minimal information about them.

Example Output

{
	"page": 0,
	"pageSize": 0,
	"count": 0,
	"list": [
		{
			"id": "string",
			"ironcladId": "string",
			"type": "string",
			"typeDisplayName": "string",
			"name": "string",
			"lastUpdated": "string",
			"properties": {},
			"attachments": {},
			"links": [
				{
					"recordId": "string"
				}
			],
			"parentId": "string",
			"parentLinkType": "string",
			"childIds": [
				"string"
			],
			"contractStatus": {
				"status": "string",
				"enhancedStatus": "string",
				"remainingDuration": "string",
				"eventDate": "string",
				"message": "string"
			},
			"source": {},
			"amendments": [
				"string"
			]
		}
	]
}

Workflow Library Example

List Records with Ironclad and Send Results Via Email

Preview this Workflow on desktop