arcade-mcp/toolkits/freshservice_api/arcade_freshservice_api/wrapper_tools/GetAllFreshserviceRequesters.json

{
  "name": "GetAllFreshserviceRequesters",
  "fully_qualified_name": "FreshserviceApi.GetAllFreshserviceRequesters@0.1.0",
  "description": "Retrieve a list of all requesters in Freshservice.\n\nUse this tool to get a comprehensive list of all requesters from the Freshservice platform, suitable for managing or reviewing requester information.",
  "toolkit": {
    "name": "ArcadeFreshserviceApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "entries_per_page",
        "required": false,
        "description": "Number of entries to retrieve in each page of the 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."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "per_page"
      },
      {
        "name": "page_number_to_retrieve",
        "required": false,
        "description": "The page number to retrieve from the list of Freshservice requesters.",
        "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 to find the corresponding requester.",
        "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 requesters by their mobile phone number to return matching entries.",
        "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": "work_phone_number_for_requesters",
        "required": false,
        "description": "The work phone number to filter requesters with that specific number in Freshservice.",
        "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": "query_filter",
        "required": false,
        "description": "URL-encoded query filter to apply to the list of requesters. Supports first_name, last_name, job_title, primary_email, and more.",
        "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 requesters. This string needs to be URL encoded.<br/> Supported Query Parameters:<br/>first_name, last_name, job_title, primary_email, secondary_emails, 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/requesters?query=\"job_titile:'HR Manager' AND created_at:>'2018-08-10'\""
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "query"
      },
      {
        "name": "filter_active_accounts",
        "required": false,
        "description": "Include only active user accounts if true. If false, include only deactivated accounts. Leaving unspecified returns 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-requesters'.",
    "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/requesters",
    "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": "work_phone_number_for_requesters",
        "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": "active",
        "tool_parameter_name": "filter_active_accounts",
        "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": "query_filter",
        "description": "The simple or compound query which needs to be applied as a filter to the list of requesters. This string needs to be URL encoded.<br/> Supported Query Parameters:<br/>first_name, last_name, job_title, primary_email, secondary_emails, 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/requesters?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 requesters. This string needs to be URL encoded.<br/> Supported Query Parameters:<br/>first_name, last_name, job_title, primary_email, secondary_emails, 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/requesters?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
      }
    ]
  }
}