Skip to main content
GET
List customers

Authorizations

X-Suby-Api-Key
string
header
required

Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).

Query Parameters

limit
integer
default:20

Page size (1–100).

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor from a previous pagination.nextCursor.

email
string<email>

Exact-match filter by email.

externalRef
string

Exact-match filter on the merchant business reference.

Maximum string length: 120

Free-text lookup · name (words in any order), email, customer id, linked Discord / Telegram username or user id, or wallet address (6 characters or more). Every word must match.

Maximum string length: 120
Example:

"jane doe"

since
integer

Inclusive createdAt lower bound, in ms epoch.

Required range: x >= 0
Example:

1743638400000

until
integer

Inclusive createdAt upper bound, in ms epoch.

Required range: x >= 0
Example:

1751414400000

Response

Customers retrieved

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

message
string