- Category: developer tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 32
- Triggers: 0
- Slug:
REDCIRCLE_API - Version: 20261101_00
Tools
Add Zipcodes
Add Zipcodes
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
Output
Clear Collection Requests
Clear Collection Requests
Create Collection
Create Collection
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
Output
Create Destination
Create Destination
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
Output
Create Requests
Create Requests
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
Output
Delete Collection
Delete Collection
Delete Destination
Delete Destination
Delete Request from Collection
Delete Request from Collection
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
Output
Delete Requests In Bulk
Delete Requests In Bulk
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
Output
Delete Zipcodes
Delete Zipcodes
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
Output
Get Account Information
Get Account Information
Get Collection
Get Collection
Get Requests CSV Links
Get Requests CSV Links
Get Requests JSON Links
Get Requests JSON Links
Get Result Set CSV
Get Result Set CSV
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
Output
Get Result Set JSON
Get Result Set JSON
Get Result Set JSON Lines
Get Result Set JSON Lines
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
Output
Get Target Product Data
Get Target Product Data
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
Output
List Categories
List Categories
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
Output
List Collections
List Collections
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
Output
List Destinations
List Destinations
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
Output
List Error Logs
List Error Logs
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
Output
List Requests by Page
List Requests by Page
List Result Sets
List Result Sets
List Zipcodes
List Zipcodes
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
Output
Resend Webhook
Resend Webhook
Start Collection
Start Collection
Stop All Collections
Stop All Collections
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
Stop Collection
Stop Collection
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
Output
Update Collection
Update Collection
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
Output
Update Destination
Update Destination
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
Output
Update Request
Update Request
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.