---
title: "List contract fields metadata"
method: GET
path: "/contracts/metadata"
tags: ["Contracts Fields"]
---

# List contract fields metadata

`GET /contracts/metadata`

## Request

- Base URL: `https://api.toriihq.com/v1.0`
- URL: `https://api.toriihq.com/v1.0/contracts/metadata`
- Auth: API key in header `Authorization`

List contract fields (predefined and custom).<br/><br/>The list of options for dropdown and multi dropdown fields is not provided by this API.<br/><br/>You can search by field name or key.<br/><br/>
<p><ul><li>Rate limit: 200 requests per minute</li></ul></p>

## Query parameters

- `q` string

## Response `200`

Contract Metadata

- ContractMetadata: Contract Metadata
  - `predefinedFields` Model27[]
    - `name` string, required
    - `systemKey` string, required
    - `type` 'number' | 'singleLine' | 'multiLine' | 'email' | 'currency' | 'cardNumber' | 'datePicker' | 'dropdown' | 'dropdownMulti' | 'usersDropdown' | 'user' | 'bool' | 'fileUpload' | 'contractsDropdownMulti' | 'usersDropdownMulti' | 'appUserAccount' | 'multiValueString', required
    - `description` string: What the field measures when its name alone does not say, e.g. its time window
    - `filterType` 'longText' | 'text' | 'number' | 'currency' | 'bool' | 'dropdown' | 'dropdownMulti' | 'date' | 'user' | 'userMulti' | 'name' | 'freeText' | 'appUserAccount' | 'fileUpload' | 'contractsDropdownMulti'
    - `filterSystemKey` string
    - `relatedFields` string[]
    - `scopes` Model26[]
    - `feature` 'integration.slack:action.askTorii' | 'page.appCatalog' | 'page.appCatalog:tab.policies' | 'page.appCatalog:tab.settings' | 'page.application' | 'page.application:tab.chargeback' | 'page.application:tab.contracts' | 'page.application:tab.discoveredApps' | 'page.application:tab.expenses' | 'page.application:tab.info' | 'page.application:tab.overview' | 'page.application:tab.recommendations' | 'page.application:tab.securityGrade' | 'page.application:tab.users' | 'page.applications' | 'page.applications:tab.compare' | 'page.applications:tab.refine' | 'page.applications:tab.review' | 'page.expenses' | 'page.expenses:tab.allExpenses' | 'page.expenses:tab.costAllocation' | 'page.expenses:tab.expenseFiles' | 'page.expenses:tab.matchingRules' | 'page.expenses:tab.overview' | 'page.insights' | 'page.integrations' | 'page.integrations:type.custom' | 'page.integrations:type.expenses' | 'page.integrations:type.googleSheets' | 'page.integrations:type.integrationBuilder' | 'page.integrations:type.idp' | 'page.integrations:type.hrms' | 'page.integrations:type.deviceManagement' | 'page.integrations:type.generalDirectIntegrations' | 'page.integrations:feature.customSyncSchedule' | 'page.licenses' | 'page.licenses:component.benchmark' | 'page.licenses:tab.chargeback' | 'page.licenses:tab.current' | 'page.licenses:tab.recommendations' | 'page.licenses:tab.trend' | 'page.offboarding' | 'page.pluginMarketplace' | 'page.realizedSavings' | 'page.renewals' | 'page.renewals:component.contractAI' | 'page.renewals:tab.calendar' | 'page.renewals:tab.contracts' | 'page.reports' | 'page.security' | 'page.settings' | 'page.settings:tab.apiAccess' | 'page.settings:tab.applicationDetails' | 'page.settings:tab.browserExtension' | 'page.settings:tab.contractDetails' | 'page.settings:tab.customApps' | 'page.settings:tab.emails' | 'page.settings:tab.general' | 'page.settings:tab.hiddenApps' | 'page.settings:tab.labs' | 'page.settings:tab.members' | 'page.settings:tab.members:component.inviteMembersByRole' | 'page.settings:tab.members:tab.appOwners' | 'page.settings:tab.members:tab.toriiUsers' | 'page.settings:tab.roles' | 'page.settings:tab.roles:component.customRoles' | 'page.settings:tab.roles:role.procurement' | 'page.settings:tab.secretsVault' | 'page.settings:tab.security' | 'page.settings:tab.usersAndEmployees' | 'page.settings:tab.usersAndEmployees:feature.automaticallyReassignStakeholder' | 'page.settings:tab.usersAndEmployees:feature.automaticallyReassignStakeholder:entity.contracts' | 'page.user' | 'page.user:tab.ownedNonHumanUsers' | 'page.users' | 'page.users:tab.employees' | 'page.users:tab.nonHumanUsers' | 'page.users:tab.externalUsers' | 'page.users:tab.users' | 'page.workflows' | 'page.tasks' | 'feature.emailToContract' | 'mergeUsers' | 'customSendingDomain' | 'appCompliance' | 'blockAccess' | 'shareReports' | 'scheduledReports' | 'page.reports:tab.reports' | 'page.dashboards' | 'page.dashboards:feature.viewAdvancedNativeDashboards' | 'page.dashboards:feature.viewDrillDownData' | 'page.dashboards:feature.updateLayout' | 'page.dashboards:feature.updateWidgetConfig' | 'page.dashboards:feature.accessPermissions' | 'page.dashboards:feature.createDeleteDashboard' | 'feature.offboarding' | 'feature.contracts' | 'feature.expenses' | 'feature.licenses' | 'feature.security' | 'feature.accessReviews' | 'feature.accessPolicies' | 'page.settings:tab.applicationDetails:feature.smartFields' | 'page.aiHome' | 'feature.aiEvents' | 'costAllocation:bulk'
  - `customFields` Model28[]
    - `idField` integer: Unique identifier
    - `systemKey` string, required
    - `isShown` boolean
    - `idOrg` integer: Unique org identifier
    - `sourceIdApp` integer: Unique app identifier
    - `name` string
    - `type` string
    - `isDeleted` boolean
    - `relatedFields` string[]

---

[API](https://skmtc.dev/toriihq/apis/torii-api-documentation.md) - [All operations](https://skmtc.dev/toriihq/apis/torii-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/toriihq/apis/torii-api-documentation/revisions/15fd1512591b?raw)