🚧

Beta — subject to change. This endpoint is publicly available, but its request/response shape may evolve before General Availability as we incorporate early feedback.

Searches customers using a structured filter body with nested logical operators (and, or) and per-field comparators. Use this when the flat query parameters on GET /customers aren’t expressive enough. The response payload matches GET /customers.

Only the fields listed in the request schema may appear in filter and order; unknown fields return 422. Custom fields on customers are behind a feature flag — contact [email protected] to enable. Once enabled, custom field values are addressable via custom_fields.<uuid> nested paths, in both filter and order. The bare custom_fields object is not itself filterable or orderable — ordering by a whole JSON object is meaningless, so only nested custom_fields.<uuid> paths are accepted.