NinjaPipeInstall

Summary

Discover company fields by sampling records and returning field metadata.

Inputs

• limit — Maximum number of items to return per page (1-100).
• search — Free-text search term applied to the endpoint.
• statusFilter — Filter records by status value.
• ownerFilter — Filter records by owner identifier.
• queryParams — Additional query parameters to attach to the request.
• advancedQueryJson — Raw JSON string of extra query parameters merged last.
• returnAll — Return all matching records, ignoring the limit setting.
• resourcePathOverride — Override the default resource path if the workspace uses a custom endpoint.

Output shape

An array of objects describing the sampled Company record; each object includes resource, endpoint, recordCountSampled, topLevelFields, and customFieldKeys.

The shape may be expanded with cf_* keys when flattenCustomFields is enabled; pagination can return multiple pages if returnAll is true; limit caps page size at 100.

Examples

Example 1: Discover fields for companies using default settings.

resource: company, operation: getFields, limit: 20, returnAll: false

Example 2: Retrieve full field metadata for contacts with a search term and extra query JSON.

resource: contact, operation: getFields, search: "active", advancedQueryJson: "{"include":"email"}"

Example 3: Get field list for deals, returning all pages and disabling custom field flattening.

resource: deal, operation: getFields, limit: 100, returnAll: true, flattenCustomFields: false

Links

• n8n community nodes installation guide