Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Records

List All Records

View all records in the company, with filtering available via query parameters.

OAuth Scope required: public.records.readRecords

get/records

Query parameters

pageinteger

The page number used when paginating through a list of results.

pageSizeinteger

A limit of the number of results to return.

hydrateEntitiesboolean

Indicates whether to fully hydrate related entities (true) or return minimal information (false).

typesstring

Comma separated (no spaces) record types to export. Use the Retrieve Records Schema endpoint to retrieve a list of types.

lastUpdatedstring

Get records updated since (UTC)

filterstring

Filter records using a formula. The record property ID should be enclosed in brackets [ ] and the value should be enclosed in single quotes ' '.

Record properties can be identified using the Retrieve Records Schema endpoint.

Supported formula operations include the following with documentation found here:

<ul> <li>Equals / NotEqual</li> <li>Contains</li> <li>IsEmpty / IsNotEmpty</li> <li>LessThan / LessThanOrEqual</li> <li>GreaterThan / GreaterThanOrEqual</li> <li>Date / Today / RelativeDate</li> <li>And / Or</li> </ul>
searchstring

Free-text search across all record properties, matching the in-app search. Combined with filter and any other parameters using logical AND. Maximum 1000 characters.

sortField'agreementDate' | 'name' | 'lastUpdated'

The field to sort Records. Only one field is supported in the sort operation.

sortDirection'ASC' | 'DESC'

The direction the records are sorted by in correlation with the sortField.

addressAsObjectboolean

When true, returns addresses as objects instead of strings.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

200

pageinteger
pageSizeinteger
countinteger

Example response

{
  "pageSize": 20,
  "count": 1234,
  "list": [
    {
      "id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
      "ironcladId": "IC-1",
      "type": "consultingAgreement",
      "name": "Consulting Agreement with Jane Doe",
      "lastUpdated": "2018-05-08T17:28:10Z",
      "links": [
        {
          "recordId": "df1c2805-f5a3-4a14-9386-c28d950dff49"
        }
      ],
      "parentId": "d10b8c01-5c54-4a59-82cb-51e3825182e9",
      "childIds": [
        "4a785686-d3d5-47bc-960e-3df0df871ea9"
      ],
      "contractStatus": {
        "status": "active",
        "enhancedStatus": "auto-renewing",
        "remainingDuration": "P26D",
        "eventDate": "2024-07-02T00:00:00.000Z",
        "message": "Auto-renewing on Jul 2, 2024"
      },
      "source": {
        "type": "workflow",
        "workflowId": "workflow:4a785686-d3d5-47bc-960e-3df0df871ea9"
      },
      "amendments": [
        "IC-124"
      ]
    }
  ]
}