IRironcladapp
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

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/records/metadata
  • 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.readSchemas

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

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"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.