people_get_fields
Retrieve detailed field metadata for any People module to understand its schema, then use the returned API names to construct precise search queries.
Instructions
Get field metadata for a specific People module with detailed schema information\n\nPrerequisites: Module name from people_get_all_modules\nNext Steps: Use field api_name values in people_search_records operations\nCommon Pattern: Module discovery → field analysis → targeted searches\nError Recovery: If fields not found, verify module exists and check field access permissions
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"module_name": "<module_name>"
},
"name": "people_get_fields"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| field_id | No | Optional specific field ID for detailed information | |
| module_name | Yes | People module name (e.g., "employees", "departments", "attendance", "leave") |