meta_describe
Retrieve the full contract for a PrismHR method, including parameters, body schema, response codes, and verification status. Use before making an API call to ensure correct arguments.
Instructions
Full contract for a single PrismHR method.
Returns every parameter, inline body schema (when available), response
codes, and verification status. Call this before prismhr_call so
you know exactly which args the method wants.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| method_id | Yes | Catalog method id, e.g. 'payroll.v1.getBatchListByDate.GET'. Get candidates from meta_capabilities or by searching via meta_find. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| method_id | Yes | ||
| path | Yes | ||
| http_method | Yes | ||
| service | Yes | ||
| operation | Yes | ||
| summary | Yes | ||
| description | Yes | ||
| parameters | Yes | ||
| request_body_content_types | No | ||
| request_body_required_fields | No | ||
| request_body_fields | No | ||
| request_body_inline_schema_present | No | ||
| responses | Yes | ||
| verification_status | Yes | ||
| verified_response_keys | No | ||
| is_admin | Yes | ||
| remediation_if_admin | No | ||
| quirks | No | PrismHR gotchas learned from live probing — status gates, undocumented enums, silent-fail footguns. | |
| param_enums | No | Accepted enum values per parameter (often single-letter codes not obvious from the PrismHR docs). | |
| required_batch_status | No | If set, the target payroll batch must be in one of these statuses for the call to succeed. | |
| rate_limited | No | This endpoint is aggressively throttled by PrismHR. Cache responses; back off on 429. |