# RedCircle API

RedCircle API is the real-time Target product data API for accessing Target product catalog, reviews, and category data.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 32
- **Triggers:** 0
- **Slug:** `REDCIRCLE_API`
- **Version:** 00000000_00

## Tools

### Add Zipcodes

**Slug:** `REDCIRCLE_API_ADD_ZIPCODES`

Tool to add zipcodes to your RedCircle API account for geolocation targeting. Use when you need to localize product searches by specific postal codes. New zipcodes take approximately 2 minutes to become available after being added.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zipcodes` | array | Yes | Array of zipcode entries to add. Each entry specifies a zipcode and the domain where it will be used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clear Collection Requests

**Slug:** `REDCIRCLE_API_CLEAR_COLLECTION_REQUESTS`

Tool to remove all requests from a specified collection. Collections can only be cleared when not actively running. Use when you need to empty a collection of all its requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier of the collection to clear |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Collection

**Slug:** `REDCIRCLE_API_CREATE_COLLECTION`

Tool to create a new collection for running up to 15,000 requests on a schedule. Use when you need to organize and schedule batch requests with various scheduling patterns, priority levels, and notification methods.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Collection identifier name. |
| `enabled` | boolean | No | Activation status; defaults to false if omitted. |
| `priority` | string ("highest" | "high" | "normal" | "low" | "lowest") | No | Queue priority level. |
| `requests_type` | string ("mixed" | "product" | "reviews" | "search" | "category" | "store_stock") | No | Lock type - 'mixed', 'product', 'reviews', 'search', 'category', 'store_stock' (cannot be modified after creation). |
| `schedule_type` | string ("monthly" | "weekly" | "daily" | "minutes" | "manual") | No | Schedule pattern - 'monthly', 'weekly', 'daily', 'minutes', or 'manual'. |
| `schedule_hours` | array | No | Hours 0-23 for daily/weekly/monthly schedules. |
| `destination_ids` | array | No | Cloud storage bucket identifiers for result uploads. |
| `schedule_minutes` | string ("every_minute" | "every_5_minutes" | "every_10_minutes" | "every_15_minutes" | "every_30_minutes" | "every_hour") | No | Frequency - 'every_minute', 'every_5_minutes', up to 'every_hour'. |
| `notification_email` | string | No | Email address for completion notifications. |
| `notification_as_csv` | boolean | No | Enable CSV format result delivery. |
| `notification_as_json` | boolean | No | Enable JSON format result delivery. |
| `notification_webhook` | string | No | Fully qualified URL for webhook POST notifications. |
| `schedule_days_of_week` | array | No | Days 0-6 (Sunday-Saturday) for weekly/minute schedules. |
| `schedule_days_of_month` | array | No | Integer days (e.g., [1,20]) for monthly/minute schedules. |
| `notification_csv_fields` | string | No | Comma-separated CSV field list (dot notation format). |
| `notification_as_jsonlines` | boolean | No | Enable JSON Lines format result delivery. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Destination

**Slug:** `REDCIRCLE_API_CREATE_DESTINATION`

Tool to create a new destination for uploading Collection Result Sets to cloud storage. Use when you need to configure a storage destination for result sets with providers like S3, GCS, Azure, OSS, or S3-compatible storage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Destination identifier/name. |
| `type` | string ("s3" | "gcs" | "azure" | "oss" | "s3compatible") | Yes | Storage provider type. Options: s3 (Amazon S3), gcs (Google Cloud Storage), azure (Azure Blob Storage), oss (Alibaba OSS), s3compatible (S3-compatible storage). |
| `enabled` | boolean | Yes | Activation status. If true, a connectivity test will be performed by uploading and deleting a test file. |
| `s3_region` | string | No | Region identifier for S3-compatible storage. Optional when type='s3compatible'. |
| `s3_endpoint` | string | No | S3-compatible endpoint URL. Required when type='s3compatible'. |
| `oss_region_id` | string | No | Alibaba region identifier. Required when type='oss'. |
| `gcs_access_key` | string | No | Google Cloud interoperable access key. Required when type='gcs'. |
| `gcs_secret_key` | string | No | Google Cloud interoperable secret key. Required when type='gcs'. |
| `oss_access_key` | string | No | Alibaba Cloud RAM user access key. Required when type='oss'. |
| `oss_secret_key` | string | No | Alibaba Cloud RAM user secret key. Required when type='oss'. |
| `s3_bucket_name` | string | No | S3 bucket name. Required when type='s3'. |
| `s3_path_prefix` | string | No | Path prefix for S3 uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type='s3' or type='s3compatible'. |
| `gcs_bucket_name` | string | No | GCS bucket identifier. Required when type='gcs'. |
| `gcs_path_prefix` | string | No | Path prefix for GCS uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type='gcs'. |
| `oss_bucket_name` | string | No | Alibaba OSS bucket name. Required when type='oss'. |
| `oss_path_prefix` | string | No | Path prefix for OSS uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type='oss'. |
| `s3_access_key_id` | string | No | AWS access key ID. Required when type='s3'. |
| `azure_account_key` | string | No | Azure storage account key. Required when type='azure'. |
| `azure_path_prefix` | string | No | Path prefix for Azure uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type='azure'. |
| `azure_account_name` | string | No | Azure storage account name. Required when type='azure'. |
| `azure_container_name` | string | No | Azure blob container name. Required when type='azure'. |
| `s3_secret_access_key` | string | No | AWS secret access key. Required when type='s3'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Requests

**Slug:** `REDCIRCLE_API_CREATE_REQUESTS`

Tool to add up to 1,000 requests to an existing collection. Use when you need to populate a collection with product requests. Collections have a maximum of 15,000 requests (100 if include_html=true). Sequential calls required; parallel requests trigger HTTP 429 errors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requests` | array | Yes | JSON array containing request objects. Maximum 1,000 requests per call. Collections have a 15,000 request maximum (100 if include_html=true). |
| `collection_id` | string | Yes | The unique identifier of the target collection |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Collection

**Slug:** `REDCIRCLE_API_DELETE_COLLECTION`

Tool to remove a collection from the system by ID. Use when you need to delete a collection that is not currently running.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier of the collection to delete. Note: Collection cannot be deleted while actively running. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Destination

**Slug:** `REDCIRCLE_API_DELETE_DESTINATION`

Tool to remove a destination from your RedCircle API account. Use when you need to permanently delete a specific destination by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `destination_id` | string | Yes | The unique identifier of the destination to be removed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Request from Collection

**Slug:** `REDCIRCLE_API_DELETE_REQUEST`

Tool to remove an individual request from a collection. Use when you need to delete a specific request from a collection by providing both collection_id and request_id. Collections must not be running during deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | The unique identifier of the specific request to remove from the collection. |
| `collection_id` | string | Yes | The unique identifier for the collection containing the request. Collections must not be actively running to delete requests. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Requests In Bulk

**Slug:** `REDCIRCLE_API_DELETE_REQUESTS_BULK`

Tool to delete multiple requests from a collection in bulk. Use when you need to remove multiple requests efficiently. Note: Requests can only be deleted when the collection is not running.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_ids` | array | Yes | An array of Request ID strings to be deleted from the collection. Bulk deletion is typically quicker than sequential calls and helps avoid rate-limit errors. |
| `collection_id` | string | Yes | The identifier of the collection containing requests to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Zipcodes

**Slug:** `REDCIRCLE_API_DELETE_ZIPCODES`

Tool to remove zipcodes from your RedCircle API account. Use when you need to delete specific zipcode/domain pairs from your account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zipcodes` | array | Yes | List of zipcode/domain pairs to remove from the account. Each entry must include both zipcode and domain fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Information

**Slug:** `REDCIRCLE_API_GET_ACCOUNT`

Tool to retrieve account information, usage metrics, and platform status. Use when you need to check account credits, limits, plan details, or platform component status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Collection

**Slug:** `REDCIRCLE_API_GET_COLLECTION`

Tool to retrieve complete information about a specific collection. Use when you need detailed collection metadata including status, schedule, and configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier of the collection to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Requests CSV Links

**Slug:** `REDCIRCLE_API_GET_REQUESTS_CSV_LINKS`

Tool to retrieve CSV download links for all requests in a collection. Use when you need to export request data in CSV format. Each CSV file contains up to 1000 requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The ID of the collection for which to retrieve CSV download links. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Requests JSON Links

**Slug:** `REDCIRCLE_API_GET_REQUESTS_JSON_LINKS`

Tool to retrieve download links for all requests in a collection in JSON format. Use when you need to access request data from a specific collection. Returns paginated URLs for downloading request information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier of the collection to retrieve requests from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Result Set CSV

**Slug:** `REDCIRCLE_API_GET_RESULT_SET_CSV`

Tool to retrieve a result set in CSV format with optional field filtering. Use when you need to export processed results from a collection as CSV files. Supports field selection using dot notation for nested fields. Results maintain 14-day retention.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `csv_fields` | string | No | Comma-separated list of fields to include in the CSV output. Use dot notation for nested fields (e.g., 'field1,field2,nested.field3'). If not provided, all fields are included. |
| `collection_id` | string | Yes | The unique identifier of the collection. |
| `result_set_id` | string | Yes | The unique identifier of the result set within the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Result Set JSON

**Slug:** `REDCIRCLE_API_GET_RESULT_SET_JSON`

Tool to retrieve a result set in JSON format with download links. Use when you need to access processed results from a specific collection and result set. Returns detailed result information including download URLs for data files.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier of the collection. |
| `result_set_id` | string | Yes | The unique identifier of the result set within the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Result Set JSON Lines

**Slug:** `REDCIRCLE_API_GET_RESULT_SET_JSONLINES`

Tool to retrieve a result set in JSON Lines format with download links. Use when you need to access processed results as newline-delimited JSON files. JSON Lines format provides one valid JSON object per line, ideal for streaming and processing large datasets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier of the collection. |
| `result_set_id` | string | Yes | The unique identifier of the result set within the collection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Target Product Data

**Slug:** `REDCIRCLE_API_GET_TARGET_PRODUCT_DATA`

Tool to retrieve Target data in real-time including search results, product information, reviews, or category listings. Use when you need to access Target.com product data such as searching for products, getting specific product details, retrieving reviews, or listing categories.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination control of result sets. |
| `tcin` | string | No | Target's unique product identifier (Target.com Item Number) for specific product lookup. Required when type='product'. |
| `type` | string ("search" | "product" | "reviews" | "category") | Yes | Specifies the data type to retrieve. Valid values: 'search' for product search results, 'product' for specific product details, 'reviews' for product reviews, 'category' for category listings. |
| `sort_by` | string | No | Ordering method for search results (e.g., 'best_seller'). |
| `category_id` | string | No | Target category identifier for category listings. Required when type='category' and 'url' is not specified. |
| `search_term` | string | No | Search query for product discovery (e.g., 'highlighter pens', 'laptop'). Required when type='search'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Categories

**Slug:** `REDCIRCLE_API_LIST_CATEGORIES`

Tool to retrieve all top-level (root) categories or filter results using optional parameters. Use when you need to browse the category hierarchy, search for specific categories, or retrieve category details. Parameters id, parent_id, and search_term are mutually exclusive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Single category identifier to retrieve specific category details. Cannot be used with parent_id or search_term. |
| `parent_id` | string | No | Parent category ID to retrieve child categories. Cannot be used with id or search_term. |
| `search_term` | string | No | Search phrase to filter across category hierarchy (e.g., 'appliances'). Cannot be used with id or parent_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Collections

**Slug:** `REDCIRCLE_API_LIST_COLLECTIONS`

Tool to retrieve all collections configured on your RedCircle API account with filtering and pagination. Use when you need to browse collections, filter by status or search term, or manage collection metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (defaults to 1) |
| `status` | string ("all" | "idle" | "queued" | "running") | No | Filter by Collection status: 'all', 'idle', 'queued', or 'running' (defaults to all) |
| `sort_by` | string ("created_at" | "last_run" | "name" | "priority" | "status") | No | Sort collections by: 'created_at', 'last_run', 'name', 'priority', or 'status' |
| `page_size` | integer | No | Results per page; defaults to 25, maximum 1000 |
| `search_term` | string | No | Limits results to Collections matching the search term in their name |
| `search_type` | string ("contains" | "starts_with" | "ends_with" | "exact") | No | Determines search matching strategy: 'contains' (default), 'starts_with', 'ends_with', or 'exact' |
| `created_after` | string | No | Filter Collections created after specified timestamp (ISO 8601 format) |
| `created_before` | string | No | Filter Collections created before specified timestamp (ISO 8601 format) |
| `destination_id` | string | No | Filter to Collections with specified destination ID |
| `last_run_after` | string | No | Filter Collections by last run date after specified timestamp (ISO 8601 format) |
| `sort_direction` | string ("ascending" | "descending") | No | Sort direction: 'ascending' (default) or 'descending' |
| `last_run_before` | string | No | Filter Collections by last run date before specified timestamp (ISO 8601 format) |
| `only_with_results` | boolean | No | Filter to return only Collections containing result sets |
| `only_without_results` | boolean | No | Filter to return only Collections without result sets |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Destinations

**Slug:** `REDCIRCLE_API_LIST_DESTINATIONS`

Tool to retrieve all destinations configured on your RedCircle API account with pagination and filtering. Use when you need to browse or manage destination configurations. Returns 10 destinations per page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Set the page number of Destinations to return. Defaults to page=1. 10 Destinations are returned per page. |
| `sort_by` | string ("type" | "name") | No | Sort destinations by 'type' or 'name'. |
| `search_term` | string | No | Filters results to destinations containing this term in their name. |
| `sort_direction` | string ("ascending" | "descending") | No | Sort direction: 'ascending' (default) or 'descending'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Error Logs

**Slug:** `REDCIRCLE_API_LIST_ERROR_LOGS`

Tool to list all error logs on your RedCircle API account. Use when you need to retrieve failed API request logs with error details. Results are paginated with 10 error logs per page. Supports filtering by search term and sorting by date or count.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Set the page number of error logs to return, defaults to page=1. 10 error logs are returned per page. |
| `sort_by` | string | No | The sort order to apply to the results. Valid values are 'date' (to sort by error log date) or 'count' (to sort by error log count). |
| `search_term` | string | No | Limits the error logs returned to just those containing the search_term in their parameters property. |
| `sort_direction` | string | No | The sort direction to return results. Valid values are 'descending' or 'ascending' (the default). Use in conjunction with the sort_by parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Requests by Page

**Slug:** `REDCIRCLE_API_LIST_REQUESTS_BY_PAGE`

Tool to retrieve requests for a collection in paginated format. Use when you need to access collection requests with pagination support (max 1000 requests per page).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | Yes | Page number for pagination (starts at 1, max 1000 requests per page) |
| `collection_id` | string | Yes | The collection identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Result Sets

**Slug:** `REDCIRCLE_API_LIST_RESULT_SETS`

Tool to list all result sets for a collection. Use when you need to retrieve execution history and results for a specific collection. Note: result sets have 14-day retention.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier of the collection to retrieve result sets for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Zipcodes

**Slug:** `REDCIRCLE_API_LIST_ZIPCODES`

Tool to retrieve all zipcodes associated with your account with optional filtering. Use when you need to list zipcodes, optionally filtered by search term or domain. Supports pagination with max 10 results per page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Specifies which page of results to return; max 10 results per page. Must be >= 1. |
| `domain` | string | No | Filters results to zipcodes associated with a specific domain. |
| `search_term` | string | No | Limits the returned zipcodes to just those containing the search_term (e.g., search_term=455). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resend Webhook

**Slug:** `REDCIRCLE_API_RESEND_WEBHOOK`

Tool to resend a previously configured webhook POST request for a result set. Use when you need to debug webhook connectivity issues without re-executing the collection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier for the collection |
| `result_set_id` | string | Yes | The unique identifier for the result set |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Collection

**Slug:** `REDCIRCLE_API_START_COLLECTION`

Tool to initiate execution of a RedCircle API collection. Use when you need to start processing requests for a collection. Requires sufficient request credits and the collection must not be currently running.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier of the collection to start. Must be a valid collection ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop All Collections

**Slug:** `REDCIRCLE_API_STOP_ALL_COLLECTIONS`

Tool to halt all currently active collections on your account. Use when you need to terminate all collection operations across your account. Collections in queued or running states are affected, resetting status to idle. Note: Queued collections receive credit refunds; running collections stop without reimbursement.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Stop Collection

**Slug:** `REDCIRCLE_API_STOP_COLLECTION`

Tool to halt an active collection in queued or running state. Use when you need to stop a collection that is currently processing. Collections in queued status receive full credit refunds, while running collections are stopped without refunds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier of the collection to stop. The collection must be in queued or running state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Collection

**Slug:** `REDCIRCLE_API_UPDATE_COLLECTION`

Tool to update an existing collection's configuration and settings. Use when you need to modify collection settings including name, schedule, priority, and destination assignments. Note: A collection can only be updated when it is not running.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the Collection |
| `enabled` | boolean | No | Determines if the Collection runs automatically on schedule. Set to true to enable or false to disable. |
| `priority` | string | No | Collection execution priority when queued. Valid values: highest, high, normal, low, lowest. |
| `collection_id` | string | Yes | The unique identifier of the collection to update |
| `requests_type` | string | No | Lock collection to specific request types. Valid values: mixed, product, reviews, search, category, store_stock. |
| `schedule_type` | string | No | Determines the type of schedule. Valid values: monthly, weekly, daily, minutes, manual. |
| `schedule_hours` | array | No | Hours when collection runs where 0=midnight and 23=11pm. Valid values: 0-23. |
| `destination_ids` | array | No | Specifies an array of Destination IDs that Result Sets are uploaded to (S3, GCS, Azure, Alibaba buckets). |
| `schedule_minutes` | string | No | Frequency for minute-based scheduling. Valid values: every_minute, every_5_minutes, every_10_minutes, every_15_minutes, every_20_minutes, every_25_minutes, every_30_minutes, every_hour. Only applicable when schedule_type is 'minutes'. |
| `notification_email` | string | No | The email address to send notifications to when new Result Sets are available. |
| `notification_as_csv` | boolean | No | Enable CSV format in notifications. Set to true to enable or false to disable. |
| `notification_as_json` | boolean | No | Enable JSON format in notifications. Set to true to enable or false to disable. |
| `notification_webhook` | string | No | The URL RedCircle API will send a webhook POST to. Must be a fully qualified HTTPS URL. |
| `schedule_days_of_week` | array | No | Array of days of the week (as integers) to run the Collection where 0=Sunday and 6=Saturday. Valid values: 0-6. Only applicable when schedule_type is 'weekly'. |
| `schedule_days_of_month` | array | No | Array of days of the month to run the Collection. Valid values: 1-31. Only applicable when schedule_type is 'monthly'. |
| `notification_csv_fields` | string | No | CSV fields to include in results using comma-separated dot notation (e.g., 'field1,field2.subfield'). |
| `notification_as_jsonlines` | boolean | No | Enable JSON Lines format in notifications. Set to true to enable or false to disable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Destination

**Slug:** `REDCIRCLE_API_UPDATE_DESTINATION`

Tool to modify an existing destination configuration on your RedCircle API account. Use when you need to update destination settings such as name, credentials, storage paths, or enable/disable status. When enabling a previously disabled destination or updating credentials, a connectivity test will be performed automatically.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the destination |
| `type` | string ("s3" | "gcs" | "azure" | "oss" | "s3compatible") | No | Destination storage provider type |
| `enabled` | boolean | No | Determines if the destination receives collection uploads. When enabling a previously disabled destination or updating credentials, RedCircle API will perform a connectivity test. |
| `s3_region` | string | No | Region identifier (e.g., eu-west-1, us-east-1, auto) |
| `s3_endpoint` | string | No | Endpoint URL. Required for s3compatible type (e.g., https://ams3.digitaloceanspaces.com) |
| `oss_region_id` | string | No | Alibaba Cloud OSS region ID (e.g., oss-cn-hangzhou, oss-us-west-1) |
| `destination_id` | string | Yes | The unique identifier of the destination to update |
| `gcs_access_key` | string | No | Google Cloud Storage interoperable storage access key |
| `gcs_secret_key` | string | No | Google Cloud Storage interoperable storage secret key |
| `oss_access_key` | string | No | Alibaba Cloud OSS RAM user access key |
| `oss_secret_key` | string | No | Alibaba Cloud OSS RAM user secret key |
| `s3_bucket_name` | string | No | Target S3 bucket name |
| `s3_path_prefix` | string | No | Path prefix for uploaded files. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE% |
| `gcs_bucket_name` | string | No | Google Cloud Storage bucket name |
| `gcs_path_prefix` | string | No | Path prefix with token support for GCS uploads |
| `oss_bucket_name` | string | No | Alibaba Cloud OSS bucket name |
| `oss_path_prefix` | string | No | Path prefix with token support for OSS uploads |
| `s3_access_key_id` | string | No | AWS access key ID. Required for S3 and S3-compatible destinations. |
| `azure_account_key` | string | No | Azure account access key |
| `azure_path_prefix` | string | No | Path prefix with token support for Azure uploads |
| `azure_account_name` | string | No | Azure storage account name |
| `azure_container_name` | string | No | Azure blob storage container name |
| `s3_secret_access_key` | string | No | AWS secret access key. Required for S3 and S3-compatible destinations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Request

**Slug:** `REDCIRCLE_API_UPDATE_REQUEST`

Tool to modify a request within a collection. Use only when the collection is not running. Updates request parameters like type, tcin, or other Target Product Data API fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tcin` | string | No | Target product identifier (TCIN) for Target Product Data API requests |
| `type` | string | No | Type of the request (e.g., 'product' for Target Product Data API) |
| `request_id` | string | Yes | The identifier of the request to update |
| `collection_id` | string | Yes | The identifier of the collection containing the request |
| `additional_params` | object | No | Additional parameters matching Target Product Data API specification. Any valid API parameters can be included here. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |