halopsa_get_api_schemas
Retrieve API schema definitions from HaloPSA to understand request and response object structures for API endpoints, with filtering and pagination support.
Instructions
Get API schemas/models from the swagger definition. Shows the structure of request/response objects used by the API endpoints. Supports pagination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| schemaPattern | No | Optional pattern to filter schemas by name (e.g., "Ticket", "Action", "Client") | |
| limit | No | Maximum number of schemas to return (default: 50) | |
| skip | No | Number of matching schemas to skip for pagination (default: 0) | |
| listNames | No | Include list of all matching schema names (default: false, auto-included if ≤20 matches) |
Input Schema (JSON Schema)
{
"properties": {
"limit": {
"default": 50,
"description": "Maximum number of schemas to return (default: 50)",
"type": "number"
},
"listNames": {
"default": false,
"description": "Include list of all matching schema names (default: false, auto-included if ≤20 matches)",
"type": "boolean"
},
"schemaPattern": {
"description": "Optional pattern to filter schemas by name (e.g., \"Ticket\", \"Action\", \"Client\")",
"type": "string"
},
"skip": {
"default": 0,
"description": "Number of matching schemas to skip for pagination (default: 0)",
"type": "number"
}
},
"type": "object"
}