List customers
Lists CustomerSummary resources in deterministic createdAt DESC, id DESC order. Canonical contact and free-text filters are case-insensitive and compose with exact identity and strict timestamp filters. Pass include=capabilities to attach capability summaries to every customer.
Authorizations
Your Swipelux API key. Obtain this from the Swipelux Dashboard.
Query Parameters
Developer correlation identifier using 1-256 printable ASCII characters.
1 - 256^[\x20-\x7E]+$Case-insensitive partial match against the canonical individual or business email. C0 controls and DEL are rejected.
1 - 256Case-insensitive partial match against the canonical individual or business phone. C0 controls and DEL are rejected.
1 - 256Case-insensitive search over customer-id prefix, canonical display name, email, phone, and business trade names. General and +phone terms require 3 characters; cus_ prefixes require 5. C0 controls and DEL are rejected.
3 - 256individual, business Exact case-insensitive match against the resolved ISO 3166-1 alpha-2 customer country.
2^[A-Za-z]{2}$Comma-separated optional expansions; surrounding whitespace around each item is ignored. Only capabilities is currently supported, and it additionally requires accounts:read or rails:read.
1capabilities Inclusive lower createdAt bound as a strict RFC 3339 timestamp.
Inclusive upper createdAt bound as a strict RFC 3339 timestamp; the complete supplied millisecond is included.
Return only records updated at or after this RFC 3339 timestamp. Use it to recover from missed webhooks by replaying a window of changes.
Related topics
List customer tasksList customer document metadataIndividual onboarding API workflowCapabilities and requirementsList recipients