Foreplay API icon

Foreplay API

Interact with the Foreplay API

Overview

This node integrates with the Foreplay API to perform various operations, including searching for brands by name. Specifically, the "Search for Brands by Name" operation allows users to query the Foreplay API to find brands matching a given text string. This is useful in scenarios where you want to filter or discover brands dynamically based on partial or full brand names.

Practical examples include:

  • Marketing automation workflows that need to fetch brand details before launching campaigns.
  • Competitive analysis tools that gather brand information from external sources.
  • Data enrichment processes where brand metadata is required based on user input or other triggers.

Properties

Name Meaning
Text Optional text query filter to search brands by name. Enter any part of the brand name.
Limit Maximum number of results to return. Defaults to 5. Must be at least 1.

Output

The node outputs an array of JSON objects under the json field. Each object corresponds to a response from the Foreplay API for the requested operation. For the "Search for Brands by Name" operation, each item in the output array contains a response property holding the API's returned data about matching brands.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Foreplay API.
  • The base URL for the Foreplay API must be configured in the node credentials.
  • The node uses HTTP requests with authentication to communicate with the Foreplay API endpoints.

Troubleshooting

  • Invalid operation error: If the specified operation is not recognized, the node throws an "Invalid operation" error. Ensure the operation name matches one of the supported options.
  • Authentication errors: If the API key or base URL is incorrect or missing, HTTP requests will fail. Verify that the API credentials are correctly set up.
  • Empty or no results: If the text query is too restrictive or misspelled, the API may return no matching brands. Try broadening the search text or removing it to get more results.
  • Limit parameter issues: Setting the limit below 1 may cause validation errors. Use a value of 1 or higher.

Links and References

Discussion