RidderIQ icon

RidderIQ

Interact with the RidderIQ API

RidderIQ

AI-generated

Summary

Make arbitrary HTTP requests to the RidderIQ API by specifying the API version, HTTP method, endpoint, and request body for POST/PUT methods, with optional filtering, pagination, and response optimization.

Inputs

  • API Version (required) — Select the RidderIQ API version to use (v1 or v2).
  • HTTP Method (required) — Choose the HTTP method to use for the API request (GET, POST, PUT, DELETE).
  • Endpoint (required) — Specify the API endpoint path to call (e.g., 'crm/todos').
  • Body — Provide a JSON body to send with POST or PUT requests.
  • Additional Options — Set optional parameters including filters (simple filter builder or advanced RSQL query), pagination (page and page size), and sorting order.
  • Optimize Response — Select to reduce the returned data by specifying a field containing data and which fields to include or exclude in the response.
  • Field Containing Data — Name of the field in the response object that contains the main data to extract when optimizing the response.
  • Include Fields — Choose to include all fields, only selected fields, or exclude specified fields from the response.
  • Fields — Comma-separated list of fields to include or exclude when response optimization is enabled.

Output shape

a list of JSON objects representing the API response data

Outputs the full API response JSON by default. When 'Optimize Response' is enabled, the output returns either the specified subfield of the response or a filtered subset of fields according to user configuration. Supports pagination parameters to retrieve multiple pages if handled externally.

Discussion