Skip to main content
List customers

Authorizations

X-API-Key
string
header
required

Your Swipelux API key. Obtain this from the Swipelux Dashboard.

Query Parameters

cursor
string
limit
integer
externalId
string

Developer correlation identifier using 1-256 printable ASCII characters.

Required string length: 1 - 256
Pattern: ^[\x20-\x7E]+$
email
string

Case-insensitive partial match against the canonical individual or business email. C0 controls and DEL are rejected.

Required string length: 1 - 256
phone
string

Case-insensitive partial match against the canonical individual or business phone. C0 controls and DEL are rejected.

Required string length: 1 - 256

Case-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.

Required string length: 3 - 256
type
enum<string>
Available options:
individual,
business
country
string

Exact case-insensitive match against the resolved ISO 3166-1 alpha-2 customer country.

Required string length: 2
Pattern: ^[A-Za-z]{2}$
include
enum<string>[]

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.

Minimum array length: 1
Available options:
capabilities
createdAfter
string<date-time>

Inclusive lower createdAt bound as a strict RFC 3339 timestamp.

createdBefore
string<date-time>

Inclusive upper createdAt bound as a strict RFC 3339 timestamp; the complete supplied millisecond is included.

updatedAfter
string<date-time>

Return only records updated at or after this RFC 3339 timestamp. Use it to recover from missed webhooks by replaying a window of changes.

Response

Customer summaries returned

data
object[]
required
nextCursor
string | null
required
hasMore
boolean
required