---
updatedAt: 2026-05-27T05:24:21.000Z
agentTools:
projectIndex: https://developers.toriihq.com/llms.txt
---
# List user fields metadata
List user fields (predefined and custom).
The list of options for dropdown and multi dropdown fields is not provided by this API.
You can search by field name or key.
- Rate limit: 200 requests per minute
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Torii API Documentation",
"version": "v1.0",
"description": "The Torii API provides an easy way to integrate your data in Torii with any external system. The API closely follows REST semantics, uses JSON to encode objects, and relies on standard HTTP codes to signal operation outcomes. Torii APIs consist of both proprietary and SCIM 2.0 APIs."
},
"x-readme": {
"explorer-enabled": true
},
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
{
"name": "User Fields"
}
],
"paths": {
"/users/metadata": {
"get": {
"summary": "List user fields metadata",
"operationId": "getUsersMetadata",
"description": "List user fields (predefined and custom).
The list of options for dropdown and multi dropdown fields is not provided by this API.
You can search by field name or key.
\n- Rate limit: 200 requests per minute
",
"parameters": [
{
"description": "The field name or key to search for",
"name": "q",
"in": "query",
"schema": {
"type": "string"
}
}
],
"tags": [
"User Fields"
],
"responses": {
"200": {
"description": "User Metadata",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/UserMetadata"
}
}
}
}
}
}
}
},
"x-alt-definitions": {
"Model1": {
"type": "object",
"properties": {
"key": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"value": {
"type": "number"
},
"groupCount": {
"type": "integer"
},
"aggregations": {
"type": "string",
"description": "Nested aggregations with the same structure as the parent"
}
},
"required": [
"key"
]
},
"aggregations": {
"type": "array",
"items": {
"$ref": "#/x-alt-definitions/Model1"
}
},
"type": {
"type": "string",
"enum": [
"create_workflow",
"delete_workflow",
"duplicate_workflow",
"update_workflow",
"restore_workflow_version",
"workflow_triggered_manually",
"create_app_approval_requested_workflow",
"update_app_approval_requested_workflow",
"delete_app_approval_requested_workflow",
"create_request_access_workflow",
"create_temporary_access_expired_workflow",
"complete_task_approval_request",
"complete_send_application_form_task",
"complete_send_contract_form_task",
"cancel_task",
"bulk_cancel_tasks",
"update_task_notification_settings",
"update_task_escalation_settings",
"update_task_assignees",
"get_tasks_as_csv",
"complete_policy_deviation_task",
"complete_custom_task",
"create_campaign",
"update_campaign",
"delete_campaign",
"archive_campaign_execution",
"conclude_campaign_execution",
"create_contract",
"create_contract_field_in_group",
"create_contract_fields_group",
"delete_contract",
"delete_contract_field",
"delete_contracts",
"import_contracts",
"update_contract",
"update_contract_field_info",
"update_contract_group_info",
"update_contracts",
"reorder_contract_details_groups",
"reorder_contract_details_fields",
"delete_contract_form_group",
"get_contracts_as_csv",
"create_contract_from_email",
"create_contract_from_bulk_upload",
"create_user_in_organization",
"update_user",
"update_user_lifecycle_status",
"update_user_form_details",
"get_app_users_as_csv",
"scim_create_user",
"scim_update_user",
"scim_delete_user",
"scim_patch_user",
"sync_manually_imported_users",
"delete_manually_imported_users",
"import_users",
"update_mapping_and_import_users",
"delete_manually_imported_licenses_for_app_account",
"get_apps_users_as_csv",
"add_app_from_catalog",
"add_custom_app",
"create_custom_app_token",
"delete_app_details",
"delete_chargeback",
"edit_app",
"update_app_details",
"update_app_details_file",
"update_app_is_hidden",
"update_apps_details",
"update_chargeback",
"update_cost_allocation_rule",
"apply_cost_allocation",
"cost_allocation_update_now",
"undiscover_app_self_serve",
"get_apps_as_csv",
"delete_field",
"create_field_in_group",
"create_new_app_form_group",
"delete_app_form_group",
"reorder_app_form_groups",
"reorder_app_form_fields",
"update_field_info",
"update_group_info",
"copy_app_data",
"try_match_apps",
"bulk_insert_transactions",
"parse_existing_upload_for_expenses",
"parse_manually",
"update_transaction",
"create_org_matching_rule",
"delete_org_matching_rule",
"update_org_matching_rule",
"create_org_excluded_term",
"delete_org_excluded_term",
"update_org_excluded_term",
"update_org_matching_rules",
"get_transactions_as_csv",
"apply_lifecycle_settings",
"create_org_saml",
"create_public_api_key",
"delete_org_saml",
"create_org_saml_by_source",
"delete_public_api_key",
"update_is_scim_enabled",
"update_org_offboarding_properties",
"update_org_properties",
"update_org_saml",
"upload_org_logo",
"upload_org_image",
"create_org_secret",
"delete_org_secret",
"update_org_secret_value",
"delete_logo_type",
"update_org_isToriiSupportAllowedForOrg",
"update_extension_settings",
"create_role",
"delete_role",
"update_role",
"create_auth_token_after_test_connection",
"invite_member",
"login",
"login_failed",
"signup_as_new_user",
"update_entity_permissions",
"add_entity_access_link",
"update_entity_access_link",
"create_ai_dashboards_guest_link",
"delete_ai_dashboards_guest_link",
"call_run_sync",
"sync_custom_integration",
"sync_gluu_custom_integration",
"update_app_account",
"connect_",
"generate_instant_access_url_for_service_connection_delegate",
"create_auth_token",
"delete_auth_token",
"bulk_update_licenses_price",
"bulk_update_app_licenses",
"update_license_price",
"upload",
"create_upload",
"delete_upload",
"update_org_labs_feature",
"create_test_connection",
"update_org_catalog_properties",
"trigger_app_access_request_policy",
"bulk_trigger_app_access_request_policies",
"create_plugin",
"update_plugin",
"delete_plugin",
"install_plugin",
"uninstall_plugin",
"plugin_generate_api_key",
"create_merge_users_rule",
"update_merge_users_rule",
"delete_merge_users_rule",
"create_sending_domain",
"delete_sending_domain",
"verify_sending_domain",
"set_sending_domain_default_sender",
"send_sending_domain_test_email",
"clear_sending_domain_default_sender",
"create_anonymize_request",
"create_report",
"delete_report",
"update_report",
"get_app_users_for_renewal_forecast",
"get_renewal_forecast_csv",
"create_dashboard",
"update_dashboard",
"delete_dashboard",
"update_workflow_action_savings_rate",
"create_access_request_definition",
"update_access_request_definition",
"delete_access_request_definition",
"trigger_access_request_profile",
"trigger_access_request_policy_on_behalf",
"bulk_trigger_access_request_policies_on_behalf",
"mark_access_request_as_completed",
"cancel_access_request",
"decide_access_request_approval_step",
"create_access_policy",
"update_access_policy",
"delete_access_policy",
"evaluate_access_policy_manually",
"update_access_policy_settings",
"remediate_policy_deviation",
"create_user_group",
"update_user_group",
"delete_user_group"
]
},
"enabledTypes": {
"type": "object"
},
"Model2": {
"type": "object",
"properties": {
"personalData": {
"type": "boolean"
},
"creditCard": {
"type": "boolean"
},
"credentials": {
"type": "boolean"
}
},
"required": [
"personalData",
"creditCard",
"credentials"
]
},
"op": {
"type": "object"
},
"value": {
"type": "array",
"items": {
"type": "string"
}
},
"Model3": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"op": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"$ref": "#/x-alt-definitions/op"
}
]
},
"value": {
"$ref": "#/components/schemas/Model28"
},
"key": {
"type": "string",
"x-alternatives": [
{
"type": "string"
},
{
"$ref": "#/x-alt-definitions/op"
}
]
}
}
},
"filters": {
"type": "array",
"items": {
"$ref": "#/x-alt-definitions/Model3"
}
},
"Model4": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"filters": {
"$ref": "#/x-alt-definitions/filters"
}
},
"required": [
"id",
"filters"
]
},
"usersFilter": {
"type": "array",
"items": {
"$ref": "#/x-alt-definitions/Model4"
}
},
"Model5": {
"type": "array",
"items": {
"$ref": "#/x-alt-definitions/Model3"
}
},
"CurrencyValue": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Amount in smallest currency unit (e.g. cents)"
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code (e.g. \"USD\", \"EUR\")"
}
},
"required": [
"value",
"currency"
]
},
"Model6": {
"type": "array",
"maxItems": 100,
"items": {
"$ref": "#/x-alt-definitions/Model3"
}
},
"Model7": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"filters": {
"$ref": "#/x-alt-definitions/Model6"
}
},
"required": [
"id",
"filters"
]
},
"Model8": {
"type": "array",
"maxItems": 100,
"items": {
"$ref": "#/x-alt-definitions/Model7"
}
},
"Model9": {
"type": "array",
"maxItems": 100,
"items": {
"$ref": "#/x-alt-definitions/Model3"
}
}
},
"servers": [
{
"url": "https://api.toriihq.com/v1.0"
}
],
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"x-bearer-format": "bearer"
}
},
"schemas": {
"type": {
"type": "string",
"example": "singleLine",
"enum": [
"number",
"singleLine",
"multiLine",
"email",
"currency",
"cardNumber",
"datePicker",
"dropdown",
"dropdownMulti",
"usersDropdown",
"user",
"bool",
"fileUpload",
"contractsDropdownMulti",
"usersDropdownMulti",
"appUserAccount",
"multiValueString"
]
},
"filterType": {
"type": "string",
"example": "dropdown",
"enum": [
"longText",
"text",
"number",
"currency",
"bool",
"dropdown",
"dropdownMulti",
"date",
"user",
"userMulti",
"name",
"freeText",
"appUserAccount",
"fileUpload",
"contractsDropdownMulti"
]
},
"relatedFields": {
"type": "array",
"items": {
"type": "string"
}
},
"Model18": {
"type": "string",
"enum": [
"member",
"members-and-roles:read",
"members-and-roles:write",
"api-management:read",
"api-management:write",
"settings:none",
"settings:read",
"settings:write",
"public-views:read",
"public-views:write",
"integrations:read",
"integrations:write",
"automation:none",
"automation:read",
"automation:write",
"applications:read",
"applications:write",
"contracts:none",
"contracts:read",
"contracts:write",
"license-and-chargeback:none",
"license-and-chargeback:read",
"license-and-chargeback:write",
"expense:none",
"expense:read",
"expense:write",
"application-catalog:read",
"application-catalog:write",
"basic-admin",
"users:none",
"users:read",
"offboarding:none",
"offboarding:read",
"offboarding:write",
"app-owner:read",
"app-owner:write",
"all-scheduled-reports:none",
"all-scheduled-reports:read",
"all-scheduled-reports:write",
"dashboards:none",
"dashboards:read",
"dashboards:write",
"tasks:read",
"tasks:write",
"tasks:none",
"app-user-access-review:read",
"app-user-access-review:write",
"app-user-access-review:none",
"create-workflows:none",
"create-workflows:write",
"access-policies:none",
"access-policies:read",
"access-policies:write",
"ai:none",
"ai:read",
"ai:write"
]
},
"scopes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Model18"
}
},
"feature": {
"type": "string",
"enum": [
"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.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.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.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"
]
},
"Model19": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Department"
},
"systemKey": {
"type": "string",
"example": "department"
},
"type": {
"$ref": "#/components/schemas/type"
},
"filterType": {
"$ref": "#/components/schemas/filterType"
},
"filterSystemKey": {
"type": "string",
"example": "application"
},
"relatedFields": {
"$ref": "#/components/schemas/relatedFields"
},
"scopes": {
"$ref": "#/components/schemas/scopes"
},
"feature": {
"$ref": "#/components/schemas/feature"
}
},
"required": [
"name",
"systemKey",
"type"
]
},
"predefinedFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Model19"
}
},
"Model20": {
"type": "object",
"properties": {
"idField": {
"type": "integer",
"description": "Unique identifier",
"example": 1000,
"minimum": 1
},
"systemKey": {
"type": "string",
"example": "department"
},
"isShown": {
"type": "boolean",
"example": true
},
"idOrg": {
"type": "integer",
"description": "Unique org identifier",
"example": 1000,
"minimum": 1
},
"sourceIdApp": {
"type": "integer",
"description": "Unique app identifier",
"example": 1000,
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"example": "Department"
},
"type": {
"type": "string",
"example": "singleLine"
},
"isDeleted": {
"type": "boolean",
"example": false
},
"relatedFields": {
"$ref": "#/components/schemas/relatedFields"
}
},
"required": [
"systemKey"
]
},
"customFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Model20"
}
},
"UserMetadata": {
"type": "object",
"description": "User Metadata",
"properties": {
"predefinedFields": {
"$ref": "#/components/schemas/predefinedFields"
},
"customFields": {
"$ref": "#/components/schemas/customFields"
}
}
}
}
}
}
```