NinjaPipeInstall

Summary

Discover fields of a NinjaPipe resource by sampling records and returning field metadata.

Inputs

• showAdvanced — Toggle advanced options visibility.
• resourcePathOverride — Custom endpoint path override for the resource.
• returnAll — Return all matching items instead of a single page.
• limit — Maximum number of items to retrieve per page (1‑100).
• search — Search term applied to the query.
• statusFilter — Filter items by status.
• ownerFilter — Filter items by owner.
• queryParams — Additional query parameters to include.
• advancedQueryJson — Raw JSON of query parameters merged last.

Output shape

An array of objects each describing a sampled record: includes the resource name, endpoint path, recordCountSampled, and top‑level and custom field keys.

The result is a list of field metadata; pagination is limited to a single page unless returnAll is enabled.

Examples

Example 1: Discover fields of the Pipeline resource using default settings.

resource: pipeline; operation: getFields; limit: 20; returnAll: false

Example 2: List all pipeline items and get their field metadata.

resource: pipelineItem; operation: getFields; returnAll: true; limit: 100

Example 3: Search for pipelines with a specific status and retrieve field metadata.

resource: pipeline; operation: getFields; search: 'active'; statusFilter: 'Open'

Links

• n8n community nodes installation guide