arcade-mcp/toolkits/freshservice_api/arcade_freshservice_api/wrapper_tools/GetRequesterFields.json
2025-10-14 22:27:58 -03:00

145 lines
4.3 KiB
JSON

{
"name": "GetRequesterFields",
"fully_qualified_name": "FreshserviceApi.GetRequesterFields@0.1.0",
"description": "Retrieve all requester fields from Freshservice.\n\nCall this tool to obtain a comprehensive list of requester fields available in Freshservice. Useful for understanding the structure and available fields for requesters within the system.",
"toolkit": {
"name": "ArcadeFreshserviceApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "entries_per_page",
"required": false,
"description": "The number of entries to retrieve per page in a paginated list for requester fields.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The number of entries to retrieve in each page of a paginated list."
},
"inferrable": true,
"http_endpoint_parameter_name": "per_page"
},
{
"name": "page_number_to_retrieve",
"required": false,
"description": "Specify the page number of requester fields to retrieve from Freshservice.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The page number to retrieve."
},
"inferrable": true,
"http_endpoint_parameter_name": "page"
}
]
},
"output": {
"description": "Response from the API endpoint 'list-requester-fields'.",
"available_modes": [
"value",
"error",
"null"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": null,
"secrets": [
{
"key": "FRESHSERVICE_API_KEY"
},
{
"key": "FRESHSERVICE_SUBDOMAIN"
}
],
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.0.0",
"description": "Tools that enable LLMs to interact directly with the Freshservice API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.1.0",
"description": ""
},
"url": "https://{freshservice_subdomain}.freshservice.com/api/v2/requester_fields",
"http_method": "GET",
"headers": {},
"parameters": [
{
"name": "per_page",
"tool_parameter_name": "entries_per_page",
"description": "The number of entries to retrieve in each page of a paginated list.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The number of entries to retrieve in each page of a paginated list."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": 10,
"documentation_urls": []
},
{
"name": "page",
"tool_parameter_name": "page_number_to_retrieve",
"description": "The page number to retrieve.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The page number to retrieve."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": 1,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "FRESHSERVICE_API_KEY",
"parameter_name": "username",
"accepted_as": "basic_auth_username",
"formatted_value": null,
"description": "",
"is_auth_token": false
},
{
"arcade_key": "FRESHSERVICE_SUBDOMAIN",
"parameter_name": "freshservice_subdomain",
"accepted_as": "path",
"formatted_value": null,
"description": "",
"is_auth_token": false
}
]
}
}