Skip to main content
GET
List all customers for your tenant

Authorizations

Authorization
string
header
required

API Key authentication. Format: Bearer sk_live_... (production) or Bearer sk_test_... (staging). Obtain keys from Settings → Developer Console.

Query Parameters

Search by name, email, phone, or company

tier
enum<string>

Filter by customer tier

Available options:
bronze,
silver,
gold,
platinum
status
enum<string>

Filter by status

Available options:
active,
inactive,
archived
tags
string[]

Filter by tags

page
integer
default:1

Page number

limit
integer
default:20

Items per page

Required range: x <= 100

Response

200 - application/json

List of customers

success
boolean
data
object[]
pagination
object