halopsa_get_api_endpoint_details
Retrieve detailed API endpoint specifications including parameters, request/response schemas, and examples to understand how to interact with HaloPSA's API after identifying relevant endpoints.
Instructions
Get complete details for specific API endpoints including parameters, request/response schemas, and examples. Use after finding endpoints with halopsa_list_api_endpoints.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pathPattern | Yes | Path pattern to match endpoints (e.g., "ticket", "action", "client", "agent") | |
| summaryOnly | No | Return only basic endpoint information (path, methods, summary) without detailed schemas - ideal for quick API exploration | |
| includeSchemas | No | Include detailed request/response schemas (default: true, set to false to significantly reduce response size) | |
| maxEndpoints | No | Maximum number of endpoints to return (default: 10, max: 50) - helps manage response size | |
| includeExamples | No | Include request/response examples (default: false to keep responses smaller) |
Input Schema (JSON Schema)
{
"properties": {
"includeExamples": {
"default": false,
"description": "Include request/response examples (default: false to keep responses smaller)",
"type": "boolean"
},
"includeSchemas": {
"default": true,
"description": "Include detailed request/response schemas (default: true, set to false to significantly reduce response size)",
"type": "boolean"
},
"maxEndpoints": {
"default": 10,
"description": "Maximum number of endpoints to return (default: 10, max: 50) - helps manage response size",
"type": "number"
},
"pathPattern": {
"description": "Path pattern to match endpoints (e.g., \"ticket\", \"action\", \"client\", \"agent\")",
"type": "string"
},
"summaryOnly": {
"default": false,
"description": "Return only basic endpoint information (path, methods, summary) without detailed schemas - ideal for quick API exploration",
"type": "boolean"
}
},
"required": [
"pathPattern"
],
"type": "object"
}