Foreplay API icon

Foreplay API

Interact with the Foreplay API

Actions13

Get All Boards

AI-generated

Overview

This node interacts with the Foreplay API, allowing users to perform various operations such as searching ads, retrieving boards, brands, and other related data. Specifically, the "Get All Boards" operation fetches a list of all boards available in the Foreplay system. This is useful for scenarios where you want to retrieve an overview or catalog of boards to analyze or use in further automation workflows.

Practical examples include:

  • Fetching all boards to display them in a dashboard.
  • Using the list of boards to filter or trigger actions based on board-specific data.
  • Integrating board data into marketing or analytics pipelines.

Properties

Name Meaning
Limit Max number of results to return. Limits how many boards are retrieved in one execution.

The "Limit" property accepts a number (minimum 1) and controls the maximum number of boards returned by the API call.

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 "Get All Boards" operation, each item in the output array represents a board's data as returned by the API.

The structure of each board object depends on the Foreplay API's response schema but typically includes details like board ID, name, description, and other metadata.

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 API must be configured in the credentials.
  • Uses HTTP requests with authentication handled internally by n8n helpers.

Troubleshooting

  • Invalid operation error: If the operation parameter is set incorrectly or not supported, the node throws an "Invalid operation" error. Ensure the operation name matches one of the supported options.
  • API request failures: Network issues, invalid credentials, or incorrect base URL configuration can cause request failures. Verify API credentials and endpoint URLs.
  • Empty or incomplete results: If the limit is set too low, fewer boards will be returned. Adjust the "Limit" property accordingly.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if some fail, returning error messages in the output.

Links and References

Discussion