{
  "name": "RetrieveAudienceContactList",
  "fully_qualified_name": "MailchimpTransactionApi.RetrieveAudienceContactList@0.1.0",
  "description": "Retrieve contacts for a specific marketing audience.\n\nUse this tool to obtain a list of omni-channel contacts associated with a particular audience in your marketing campaigns.",
  "toolkit": {
    "name": "ArcadeMailchimpMarketingApi",
    "description": null,
    "version": "0.1.0"
  },
  "input": {
    "parameters": [
      {
        "name": "audience_id",
        "required": true,
        "description": "The unique identifier for the specific audience to retrieve contacts. Ensure this ID corresponds to an existing audience.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The unique ID for the audience."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "audience_id"
      },
      {
        "name": "fields_to_return",
        "required": false,
        "description": "A comma-separated list of fields to include in the response, using dot notation for sub-objects.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "fields"
      },
      {
        "name": "exclude_fields_list",
        "required": false,
        "description": "Comma-separated fields to exclude from the response, using dot notation for sub-objects.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "exclude_fields"
      },
      {
        "name": "number_of_records_to_return",
        "required": false,
        "description": "Specifies how many records to return, from 10 to 1000.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The number of records to return. Default value is 10. Maximum value is 1000"
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "count"
      },
      {
        "name": "pagination_cursor",
        "required": false,
        "description": "Paginate through records using a `next_cursor` from a previous request. By default, fetches the first page.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Paginate through a collection of records by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request. Default value fetches the first \"page\" of results."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "cursor"
      },
      {
        "name": "created_before_datetime",
        "required": false,
        "description": "Restricts the response to contacts created at or before the specified time. Use ISO 8601 format: YYYY-MM-DDTHH:MM:SS+00:00.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Restricts the response to contacts created at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "created_before"
      },
      {
        "name": "created_since",
        "required": false,
        "description": "Restrict contacts to those created after this timestamp (exclusive). Use ISO 8601 format: YYYY-MM-DDTHH:MM:SS+00:00.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Restricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "created_since"
      },
      {
        "name": "restrict_by_update_date_before",
        "required": false,
        "description": "Restricts the response to contacts updated at or before the specified date and time, using ISO 8601 format: YYYY-MM-DDTHH:MM:SS+00:00.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Restricts the response to contacts updated at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "updated_before"
      },
      {
        "name": "updated_since",
        "required": false,
        "description": "Restrict response to contacts updated after this time using ISO 8601 format (exclusive).",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Restricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "updated_since"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'getAudienceContactList'.",
    "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": {
      "provider_id": "arcade-mailchimp",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": null
    },
    "secrets": null,
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.1.0",
    "description": "Tools that enable LLMs to interact directly with the Mailchimp Marketing API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.2.0",
      "description": ""
    },
    "url": "/audiences/{audience_id}/contacts",
    "http_method": "GET",
    "headers": {},
    "parameters": [
      {
        "name": "fields",
        "tool_parameter_name": "fields_to_return",
        "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "exclude_fields",
        "tool_parameter_name": "exclude_fields_list",
        "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "count",
        "tool_parameter_name": "number_of_records_to_return",
        "description": "The number of records to return. Default value is 10. Maximum value is 1000",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The number of records to return. Default value is 10. Maximum value is 1000"
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "cursor",
        "tool_parameter_name": "pagination_cursor",
        "description": "Paginate through a collection of records by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request. Default value fetches the first \"page\" of results.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Paginate through a collection of records by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request. Default value fetches the first \"page\" of results."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "created_before",
        "tool_parameter_name": "created_before_datetime",
        "description": "Restricts the response to contacts created at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Restricts the response to contacts created at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "created_since",
        "tool_parameter_name": "created_since",
        "description": "Restricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Restricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "updated_before",
        "tool_parameter_name": "restrict_by_update_date_before",
        "description": "Restricts the response to contacts updated at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Restricts the response to contacts updated at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "updated_since",
        "tool_parameter_name": "updated_since",
        "description": "Restricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Restricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00."
        },
        "accepted_as": "query",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "audience_id",
        "tool_parameter_name": "audience_id",
        "description": "The unique ID for the audience.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The unique ID for the audience."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "auth_token",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "The OAuth token to use for authentication.",
        "is_auth_token": true
      }
    ],
    "request_body_spec": null,
    "use_request_body_schema_mode": false,
    "validate_request_body_schema": false,
    "url_method_call": "await utils.get_base_url(context, HTTP_CLIENT)",
    "url_method_call_field_name": "base_url"
  }
}
