NinjaPipeInstall

Summary

Discover field metadata for Deal records by sampling the first page of results.

Inputs

• showAdvanced — Toggle display of advanced options such as path override and raw JSON fields.
• resourcePathOverride — Custom endpoint path to override the default resource path.
• returnAll — Return all matching records instead of a single page.
• limit — Maximum number of records to retrieve per page (1‑100).
• search — Free‑text search term applied to the endpoint.
• statusFilter — Filter records by status (e.g., Open, Won, Lost).
• ownerFilter — Filter records by owner identifier.
• queryParams — Additional query parameters to append to the request.
• advancedQueryJson — Raw JSON query parameters merged after other query parameters.

Output shape

array of objects each containing resource, endpoint, recordCountSampled, topLevelFields, customFieldKeys, sampleRecord

Represents field metadata from the first sampled record; pagination not applicable; optional fields may be missing.

Examples

Example 1: Extract field metadata for Deal records using default settings.

Resource: Deal, Operation: Discover Deal Fields

Example 2: Search for Deals with a specific status and limit results.

Search: "Open", Limit: 50, Show Advanced Options enabled to expose Query Parameters

Example 3: Override the API endpoint path for Deal discovery.

Resource Path Override: "/custom/deals", Show Advanced Options enabled

Links

• n8n community nodes installation guide