get_api_info
Retrieve detailed API documentation for Zapmail endpoints, including parameters, responses, and practical usage examples to facilitate integration.
Instructions
Get detailed information about API endpoints, parameters, responses, and usage examples.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| category | No | API category to get information about | |
| endpoint | No | Specific endpoint name within the category | |
| includeExamples | No | Include usage examples | |
| includeScenarios | No | Include common scenarios |
Input Schema (JSON Schema)
{
"properties": {
"category": {
"description": "API category to get information about",
"enum": [
"workspace",
"domains",
"mailboxes",
"wallet",
"exports",
"users",
"billing",
"subscriptions",
"dns"
],
"type": "string"
},
"endpoint": {
"description": "Specific endpoint name within the category",
"type": "string"
},
"includeExamples": {
"default": true,
"description": "Include usage examples",
"type": "boolean"
},
"includeScenarios": {
"default": true,
"description": "Include common scenarios",
"type": "boolean"
}
},
"type": "object"
}