NinjaPipe icon

NinjaPipe

Production-ready NinjaPipe node with one action interface, safer validation, Databin webhook support, and update-friendly UX

Contact → List Contacts

AI-generated

Summary

List contacts with optional filtering, pagination, and custom query parameters.

Inputs

  • showAdvanced — Show path override and raw JSON fields for special cases
  • resourcePathOverride — Only use this if your NinjaPipe workspace exposes a different endpoint path
  • returnAll — Return all results, ignoring page/limit limits (may be heavy)
  • page — Page number for pagination
  • limit — Maximum number of items per page (max 100)
  • search — Search term to filter contacts
  • statusFilter — Filter contacts by status
  • ownerFilter — Filter contacts by owner
  • queryParams — Add Query Parameter (multiple values allowed)
  • advancedQueryJson — Optional raw query parameters merged last
  • flattenCustomFields — Copies custom_fields into the output and also adds cf_* keys

Output shape

array of contact records

Paginated response; optional pagination metadata may be omitted; flattening controlled by flattenCustomFields

Examples

Example 1: Basic contact list with default pagination

page: 1, limit: 20, showAdvanced: false

Example 2: Filtered list with search and status filter

search: "john", statusFilter: "Active", limit: 50, flattenCustomFields: true

Example 3: Full list using override path and returnAll

returnAll: true, resourcePathOverride: "/customers/contacts", limit: 100

Links

Discussion