---
title: "Retrieve Records Schema"
method: GET
path: "/records/metadata"
tags: ["Records"]
---

# Retrieve Records Schema

`GET /records/metadata`

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

**OAuth Scope required:** `public.records.readSchemas`

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Response `200`

200

- object
  - `recordTypes` object
    - `contract` object
      - `displayName` string
  - `properties` object
    - `additionalNotes` object
      - `displayName` string
      - `type` string
      - `visible` boolean
    - `agreementDate` object
      - `displayName` string
      - `type` string
      - `visible` boolean
    - `workflowId` object
      - `displayName` string
      - `type` string
      - `visible` boolean
  - `attachments` object
    - `signedCopy` object
      - `displayName` string
  - `links` object

## Other responses

- `400` — 400

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/revisions/9459b4cfc1e0/schema)