Skip to main content
RedCircle API logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 32
  • Triggers: 0
  • Slug: REDCIRCLE_API
  • Version: 20261101_00

Tools

Slug: REDCIRCLE_API_ADD_ZIPCODESTool 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

array
required
Array of zipcode entries to add. Each entry specifies a zipcode and the domain where it will be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_CLEAR_COLLECTION_REQUESTSTool 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

string
required
The unique identifier of the collection to clear

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_CREATE_COLLECTIONTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_CREATE_DESTINATIONTool 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

string
required
Destination identifier/name.
string ("s3" | "gcs" | "azure" | "oss" | "s3compatible")
required
Storage provider type. Options: s3 (Amazon S3), gcs (Google Cloud Storage), azure (Azure Blob Storage), oss (Alibaba OSS), s3compatible (S3-compatible storage).
boolean
required
Activation status. If true, a connectivity test will be performed by uploading and deleting a test file.
string
Region identifier for S3-compatible storage. Optional when type=‘s3compatible’.
string
S3-compatible endpoint URL. Required when type=‘s3compatible’.
string
Alibaba region identifier. Required when type=‘oss’.
string
Google Cloud interoperable access key. Required when type=‘gcs’.
string
Google Cloud interoperable secret key. Required when type=‘gcs’.
string
Alibaba Cloud RAM user access key. Required when type=‘oss’.
string
Alibaba Cloud RAM user secret key. Required when type=‘oss’.
string
S3 bucket name. Required when type=‘s3’.
string
Path prefix for S3 uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type=‘s3’ or type=‘s3compatible’.
string
GCS bucket identifier. Required when type=‘gcs’.
string
Path prefix for GCS uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type=‘gcs’.
string
Alibaba OSS bucket name. Required when type=‘oss’.
string
Path prefix for OSS uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type=‘oss’.
string
AWS access key ID. Required when type=‘s3’.
string
Azure storage account key. Required when type=‘azure’.
string
Path prefix for Azure uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type=‘azure’.
string
Azure storage account name. Required when type=‘azure’.
string
Azure blob container name. Required when type=‘azure’.
string
AWS secret access key. Required when type=‘s3’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_CREATE_REQUESTSTool 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

array
required
JSON array containing request objects. Maximum 1,000 requests per call. Collections have a 15,000 request maximum (100 if include_html=true).
string
required
The unique identifier of the target collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_DELETE_COLLECTIONTool to remove a collection from the system by ID. Use when you need to delete a collection that is not currently running.

Input Parameters

string
required
The unique identifier of the collection to delete. Note: Collection cannot be deleted while actively running.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_DELETE_DESTINATIONTool to remove a destination from your RedCircle API account. Use when you need to permanently delete a specific destination by its ID.

Input Parameters

string
required
The unique identifier of the destination to be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_DELETE_REQUESTTool 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

string
required
The unique identifier of the specific request to remove from the collection.
string
required
The unique identifier for the collection containing the request. Collections must not be actively running to delete requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_DELETE_REQUESTS_BULKTool 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

array
required
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.
string
required
The identifier of the collection containing requests to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_DELETE_ZIPCODESTool to remove zipcodes from your RedCircle API account. Use when you need to delete specific zipcode/domain pairs from your account.

Input Parameters

array
required
List of zipcode/domain pairs to remove from the account. Each entry must include both zipcode and domain fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_GET_ACCOUNTTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_GET_COLLECTIONTool to retrieve complete information about a specific collection. Use when you need detailed collection metadata including status, schedule, and configuration.

Input Parameters

string
required
The unique identifier of the collection to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_GET_RESULT_SET_CSVRetrieve a collection result set’s details and CSV download links, with optional field selection using dot notation for nested fields.

Input Parameters

string
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.
string
required
The unique identifier of the collection.
string
required
The unique identifier of the result set within the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_GET_RESULT_SET_JSONTool 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

string
required
The unique identifier of the collection.
string
required
The unique identifier of the result set within the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_GET_RESULT_SET_JSONLINESTool 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

string
required
The unique identifier of the collection.
string
required
The unique identifier of the result set within the collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_GET_TARGET_PRODUCT_DATARequest real-time Target search, product, review, or category data. The returned response models search and product details, but does not include review or category listing results.

Input Parameters

integer
Page number for pagination control of result sets.
string
Target’s unique product identifier (Target.com Item Number) for specific product lookup. Required when type=‘product’.
string ("search" | "product" | "reviews" | "category")
required
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.
string
Ordering method for search results (e.g., ‘best_seller’).
string
Target category identifier for category listings. Required when type=‘category’ and ‘url’ is not specified.
string
Search query for product discovery (e.g., ‘highlighter pens’, ‘laptop’). Required when type=‘search’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_LIST_CATEGORIESTool 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

string
Single category identifier to retrieve specific category details. Cannot be used with parent_id or search_term.
string
Parent category ID to retrieve child categories. Cannot be used with id or search_term.
string
Search phrase to filter across category hierarchy (e.g., ‘appliances’). Cannot be used with id or parent_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_LIST_COLLECTIONSTool 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

integer
Page number for pagination (defaults to 1)
string ("all" | "idle" | "queued" | "running")
Filter by Collection status: ‘all’, ‘idle’, ‘queued’, or ‘running’ (defaults to all)
string ("created_at" | "last_run" | "name" | "priority" | "status")
Sort collections by: ‘created_at’, ‘last_run’, ‘name’, ‘priority’, or ‘status’
integer
Results per page; defaults to 25, maximum 1000
string
Limits results to Collections matching the search term in their name
string ("contains" | "starts_with" | "ends_with" | "exact")
Determines search matching strategy: ‘contains’ (default), ‘starts_with’, ‘ends_with’, or ‘exact’
string
Filter Collections created after specified timestamp (ISO 8601 format)
string
Filter Collections created before specified timestamp (ISO 8601 format)
string
Filter to Collections with specified destination ID
string
Filter Collections by last run date after specified timestamp (ISO 8601 format)
string ("ascending" | "descending")
Sort direction: ‘ascending’ (default) or ‘descending’
string
Filter Collections by last run date before specified timestamp (ISO 8601 format)
boolean
Filter to return only Collections containing result sets
boolean
Filter to return only Collections without result sets

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_LIST_DESTINATIONSTool 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

integer
Set the page number of Destinations to return. Defaults to page=1. 10 Destinations are returned per page.
string ("type" | "name")
Sort destinations by ‘type’ or ‘name’.
string
Filters results to destinations containing this term in their name.
string ("ascending" | "descending")
Sort direction: ‘ascending’ (default) or ‘descending’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_LIST_ERROR_LOGSTool 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

integer
Set the page number of error logs to return, defaults to page=1. 10 error logs are returned per page.
string
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).
string
Limits the error logs returned to just those containing the search_term in their parameters property.
string
The sort direction to return results. Valid values are ‘descending’ or ‘ascending’ (the default). Use in conjunction with the sort_by parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_LIST_REQUESTS_BY_PAGERetrieve a page of requests for a collection, with up to 1,000 requests per page. Returned request details are limited to type, TCIN, custom ID, and request ID.

Input Parameters

integer
required
Page number for pagination (starts at 1, max 1000 requests per page)
string
required
The collection identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_LIST_RESULT_SETSTool 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

string
required
The unique identifier of the collection to retrieve result sets for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_LIST_ZIPCODESTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_RESEND_WEBHOOKTool 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

string
required
The unique identifier for the collection
string
required
The unique identifier for the result set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_START_COLLECTIONTool 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

string
required
The unique identifier of the collection to start. Must be a valid collection ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_STOP_ALL_COLLECTIONSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_STOP_COLLECTIONTool 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

string
required
The unique identifier of the collection to stop. The collection must be in queued or running state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_UPDATE_COLLECTIONTool 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

string
The name of the Collection
boolean
Determines if the Collection runs automatically on schedule. Set to true to enable or false to disable.
string
Collection execution priority when queued. Valid values: highest, high, normal, low, lowest.
string
required
The unique identifier of the collection to update
string
Lock collection to specific request types. Valid values: mixed, product, reviews, search, category, store_stock.
string
Determines the type of schedule. Valid values: monthly, weekly, daily, minutes, manual.
array
Hours when collection runs where 0=midnight and 23=11pm. Valid values: 0-23.
array
Specifies an array of Destination IDs that Result Sets are uploaded to (S3, GCS, Azure, Alibaba buckets).
string
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’.
string
The email address to send notifications to when new Result Sets are available.
boolean
Enable CSV format in notifications. Set to true to enable or false to disable.
boolean
Enable JSON format in notifications. Set to true to enable or false to disable.
string
The URL RedCircle API will send a webhook POST to. Must be a fully qualified HTTPS URL.
array
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’.
array
Array of days of the month to run the Collection. Valid values: 1-31. Only applicable when schedule_type is ‘monthly’.
string
CSV fields to include in results using comma-separated dot notation (e.g., ‘field1,field2.subfield’).
boolean
Enable JSON Lines format in notifications. Set to true to enable or false to disable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_UPDATE_DESTINATIONTool 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

string
The name of the destination
string ("s3" | "gcs" | "azure" | "oss" | "s3compatible")
Destination storage provider type
boolean
Determines if the destination receives collection uploads. When enabling a previously disabled destination or updating credentials, RedCircle API will perform a connectivity test.
string
Region identifier (e.g., eu-west-1, us-east-1, auto)
string
Endpoint URL. Required for s3compatible type (e.g., https://ams3.digitaloceanspaces.com)
string
Alibaba Cloud OSS region ID (e.g., oss-cn-hangzhou, oss-us-west-1)
string
required
The unique identifier of the destination to update
string
Google Cloud Storage interoperable storage access key
string
Google Cloud Storage interoperable storage secret key
string
Alibaba Cloud OSS RAM user access key
string
Alibaba Cloud OSS RAM user secret key
string
Target S3 bucket name
string
Path prefix for uploaded files. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%
string
Google Cloud Storage bucket name
string
Path prefix with token support for GCS uploads
string
Alibaba Cloud OSS bucket name
string
Path prefix with token support for OSS uploads
string
AWS access key ID. Required for S3 and S3-compatible destinations.
string
Azure account access key
string
Path prefix with token support for Azure uploads
string
Azure storage account name
string
Azure blob storage container name
string
AWS secret access key. Required for S3 and S3-compatible destinations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REDCIRCLE_API_UPDATE_REQUESTTool 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

string
Target product identifier (TCIN) for Target Product Data API requests
string
Type of the request (e.g., ‘product’ for Target Product Data API)
string
required
The identifier of the request to update
string
required
The identifier of the collection containing the request
object
Additional parameters matching Target Product Data API specification. Any valid API parameters can be included here.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not