343 lines
13 KiB
JSON
343 lines
13 KiB
JSON
{
|
|
"name": "GetFreshserviceAgents",
|
|
"fully_qualified_name": "FreshserviceApi.GetFreshserviceAgents@0.1.0",
|
|
"description": "Retrieve a list of all Agents in Freshservice.\n\nUse this tool to get a comprehensive list of all agents currently active in Freshservice, useful for administrative and reporting purposes.",
|
|
"toolkit": {
|
|
"name": "ArcadeFreshserviceApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "entries_per_page",
|
|
"required": false,
|
|
"description": "The number of agent entries to retrieve in each page of a paginated list. Useful for controlling the size of paginated results.",
|
|
"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": "The specific page number of the agent list to retrieve.",
|
|
"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"
|
|
},
|
|
{
|
|
"name": "requester_email",
|
|
"required": false,
|
|
"description": "The email address of the requester for which the corresponding agent needs to be listed.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The email address for which the corresponding requester needs to be listed."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "email"
|
|
},
|
|
{
|
|
"name": "filter_by_mobile_phone_number",
|
|
"required": false,
|
|
"description": "Filter agents by a specific mobile phone number to list the corresponding requesters.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The mobile phone number for which the corresponding requesters need to be listed."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "mobile_phone_number"
|
|
},
|
|
{
|
|
"name": "filter_by_work_phone_number",
|
|
"required": false,
|
|
"description": "Work phone number to filter the list of agents by their corresponding requesters.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The work phone number for which the corresponding requesters need to be listed."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "work_phone_number"
|
|
},
|
|
{
|
|
"name": "agent_type",
|
|
"required": false,
|
|
"description": "Filter agents by employment type: 'fulltime' or 'occasional'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Signifies whether the agents to be listed are full-time agents or occasional agents. Supports two possible values - fulltime, occasional."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "state"
|
|
},
|
|
{
|
|
"name": "agent_query_filter",
|
|
"required": false,
|
|
"description": "URL-encoded string for filtering agents. Supports parameters like first_name, last_name, job_title, email, etc.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The simple or compound query which needs to be applied as a filter to the list of agents. This string needs to be URL encoded.<br/> Supported Query Parameters:<br/>first_name, last_name, job_title, email, work_phone_number, mobile_phone_number, department_id, reporting_manager_id, time_zone, language, location_id, created_at, updated_at, (all custom fields).<br/>Sample Query: https://account.freshservice.com/api/v2/agents?query=\"job_titile:'HR Manager' AND created_at:>'2018-08-10'\""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "query"
|
|
},
|
|
{
|
|
"name": "filter_active_users",
|
|
"required": false,
|
|
"description": "Set to true to list active accounts, false to list deactivated ones, or omit to include both.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Signifies if the user accounts to be listed are active (true), or have been deactivated. Not applying this filter returns both active and deactivated accounts."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "active"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'list-agents'.",
|
|
"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/agents",
|
|
"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": []
|
|
},
|
|
{
|
|
"name": "email",
|
|
"tool_parameter_name": "requester_email",
|
|
"description": "The email address for which the corresponding requester needs to be listed.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The email address for which the corresponding requester needs to be listed."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "mobile_phone_number",
|
|
"tool_parameter_name": "filter_by_mobile_phone_number",
|
|
"description": "The mobile phone number for which the corresponding requesters need to be listed.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The mobile phone number for which the corresponding requesters need to be listed."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "work_phone_number",
|
|
"tool_parameter_name": "filter_by_work_phone_number",
|
|
"description": "The work phone number for which the corresponding requesters need to be listed.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The work phone number for which the corresponding requesters need to be listed."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "state",
|
|
"tool_parameter_name": "agent_type",
|
|
"description": "Signifies whether the agents to be listed are full-time agents or occasional agents. Supports two possible values - fulltime, occasional.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Signifies whether the agents to be listed are full-time agents or occasional agents. Supports two possible values - fulltime, occasional."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "active",
|
|
"tool_parameter_name": "filter_active_users",
|
|
"description": "Signifies if the user accounts to be listed are active (true), or have been deactivated. Not applying this filter returns both active and deactivated accounts.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Signifies if the user accounts to be listed are active (true), or have been deactivated. Not applying this filter returns both active and deactivated accounts."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "query",
|
|
"tool_parameter_name": "agent_query_filter",
|
|
"description": "The simple or compound query which needs to be applied as a filter to the list of agents. This string needs to be URL encoded.<br/> Supported Query Parameters:<br/>first_name, last_name, job_title, email, work_phone_number, mobile_phone_number, department_id, reporting_manager_id, time_zone, language, location_id, created_at, updated_at, (all custom fields).<br/>Sample Query: https://account.freshservice.com/api/v2/agents?query=\"job_titile:'HR Manager' AND created_at:>'2018-08-10'\"",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The simple or compound query which needs to be applied as a filter to the list of agents. This string needs to be URL encoded.<br/> Supported Query Parameters:<br/>first_name, last_name, job_title, email, work_phone_number, mobile_phone_number, department_id, reporting_manager_id, time_zone, language, location_id, created_at, updated_at, (all custom fields).<br/>Sample Query: https://account.freshservice.com/api/v2/agents?query=\"job_titile:'HR Manager' AND created_at:>'2018-08-10'\""
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"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
|
|
}
|
|
]
|
|
}
|
|
}
|