v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Records

Retrieve Records Schema

View the schema associated with contract records, including available record types and metadata properties.

OAuth Scope required: public.records.readSchemas

get/records/metadata

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

linksobject

Example response

{
  "recordTypes": {
    "contract": {
      "displayName": "Contract"
    }
  },
  "properties": {
    "additionalNotes": {
      "displayName": "Additional Notes",
      "type": "string",
      "visible": true
    },
    "agreementDate": {
      "displayName": "Agreement Date",
      "type": "date",
      "visible": true
    },
    "workflowId": {
      "displayName": "Workflow ID",
      "type": "string",
      "visible": true
    }
  },
  "attachments": {
    "signedCopy": {
      "displayName": "Signed PDF"
    }
  }
}