IRironcladapp
Records

Retrieve a Record

Changed on

View a specific record and its associated data.

OAuth Scope required: public.records.readRecords

get/records/{id}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/records/{id}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.records.readRecords

Path parameters

idstring required

The ID or Ironclad ID of the Record.

Query parameters

hydrateEntitiesboolean

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

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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. 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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Response

200

idstring required

The unique identifier of the record

ironcladIdstring required

The unique Ironclad identifier of the record

typestring required

The record type id. The same id is returned as recordType by the Workflows API, so records and workflows can be matched on record type.

typeDisplayNamestring

The human-readable label for the record type (type), for example "Consulting Agreement". Omitted when the record type has no display label; it is never returned as an empty string.

namestring required

The name of the record

lastUpdatedstring date-time required

The date (ISO8601 format) the record was last updated

propertiesRecordProperties required

The record properties associated with the record

attachmentsobject required

The attachments associated with the record keyed by the attachment key

parentIdstring

The unique identifier of the parent record

parentLinkType'amendment' | 'obligation'

Identifies the type of relationship this child record has with its parent (e.g. amendment)

childIdsstring[]

The unique identifiers of the child records

amendmentsstring[]

The unique identifiers of amendment records that amend this record

Example response

{
  "id": "22e2ff72-56a1-4711-a4ca-41328d311e9f",
  "ironcladId": "IC-1",
  "type": "consultingAgreement",
  "typeDisplayName": "Consulting Agreement",
  "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"
  ]
}

Changes

  • 435da5a4396eRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status