32 available actions

What your AI agent can do in RedCircle API

RedCircle API is the real-time Target product data API for accessing Target product catalog, reviews, and category data. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.

Common starting points

  • Get Account InformationTool to retrieve account information, usage metrics, and platform status.
  • Get CollectionTool to retrieve complete information about a specific collection.
  • Add ZipcodesTool to add zipcodes to your RedCircle API account for geolocation targeting.
  • Create CollectionTool to create a new collection for running up to 15,000 requests on a schedule.
  • Update CollectionTool to update an existing collection's configuration and settings.
  • Update DestinationTool to modify an existing destination configuration on your RedCircle API account.

Browse all 32 actions by capability

Open a capability to see every supported action and its description.

Find & reviewLook up and review existing recordsView 15 actionsHide actions
  • Get Account InformationTool to retrieve account information, usage metrics, and platform status.
  • Get CollectionTool to retrieve complete information about a specific collection.
  • Get Requests CSV LinksTool to retrieve CSV download links for all requests in a collection.
  • Get Requests JSON LinksTool to retrieve download links for all requests in a collection in JSON format.
  • Get Result Set CSVTool to retrieve a result set in CSV format with optional field filtering.
  • Get Result Set JSONTool to retrieve a result set in JSON format with download links.
  • Get Result Set JSON LinesTool to retrieve a result set in JSON Lines format with download links.
  • Get Target Product DataTool to retrieve Target data in real-time including search results, product information, reviews, or category listings.
  • List CategoriesTool to retrieve all top-level (root) categories or filter results using optional parameters.
  • List CollectionsTool to retrieve all collections configured on your RedCircle API account with filtering and pagination.
  • List DestinationsTool to retrieve all destinations configured on your RedCircle API account with pagination and filtering.
  • List Error LogsTool to list all error logs on your RedCircle API account.
  • List Requests by PageTool to retrieve requests for a collection in paginated format.
  • List Result SetsTool to list all result sets for a collection.
  • List ZipcodesTool to retrieve all zipcodes associated with your account with optional filtering.
Create & communicateCreate records or send supported messagesView 4 actionsHide actions
  • Add ZipcodesTool to add zipcodes to your RedCircle API account for geolocation targeting.
  • Create CollectionTool to create a new collection for running up to 15,000 requests on a schedule.
  • Create DestinationTool to create a new destination for uploading Collection Result Sets to cloud storage.
  • Create RequestsTool to add up to 1,000 requests to an existing collection.
Update & manageChange and manage existing recordsView 4 actionsHide actions
  • Start CollectionTool to initiate execution of a RedCircle API collection.
  • Update CollectionTool to update an existing collection's configuration and settings.
  • Update DestinationTool to modify an existing destination configuration on your RedCircle API account.
  • Update RequestTool to modify a request within a collection.
Remove & cancelRemove records or cancel supported workView 5 actionsHide actions
  • Delete CollectionTool to remove a collection from the system by ID.
  • Delete DestinationTool to remove a destination from your RedCircle API account.
  • Delete Request from CollectionTool to remove an individual request from a collection.
  • Delete Requests In BulkTool to delete multiple requests from a collection in bulk.
  • Delete ZipcodesTool to remove zipcodes from your RedCircle API account.
Other actionsSpecialist and administrative actions.View 4 actionsHide actions
  • Clear Collection RequestsTool to remove all requests from a specified collection.
  • Resend WebhookTool to resend a previously configured webhook POST request for a result set.
  • Stop All CollectionsTool to halt all currently active collections on your account.
  • Stop CollectionTool to halt an active collection in queued or running state.

Connection record

A connection you can control.

Sign-in
Customer-managed key
Setup
Use a key you create and control. It is stored securely and limited to the work agreed for the role.
Boundaries
Only the approved role and actions.
Off switch
Revoke the connection from your account.

FAQ

Before you connect RedCircle API

How does the agent connect to RedCircle API?
With a key you create and control. It is stored securely, permissions are limited to what the agent needs, and you can revoke it at any time.
What can the agent actually do in RedCircle API?
The page above lists the 32 actions currently available through the RedCircle API connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is RedCircle API included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until RedCircle API is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.

Bring the workflow together

Ready to put RedCircle API to work?

Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.

All product names, logos, and brands are property of their respective owners and are used for identification only. ZeroToClaw is not affiliated with or endorsed by RedCircle API.