Get all customers | Swipelux Documentation

HTTP request

GET /v1/customers

Query parameters

Parameter	Type	Description
`limit`	`number`	Number of customers to retrieve (default: 20, max: 100)
`offset`	`number`	Number of customers to skip (default: 0)

Example response

{
  "customers": [
    {
      "id": "cus_cK69MttD5nAUAbud1B",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+1234567890",
      "status": "approved",
      "createdAt": "2025-04-29T10:13:07.826Z",
      "updatedAt": "2025-04-29T10:13:07.826Z"
    }
  ],
  "totalCount": 1,
  "hasMore": false
}

Code examples

Authorization

X-API-Key<token>

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

In: header

Query Parameters

pageinteger

Page number for pagination (default: 1)

Minimum: 1

limitinteger

Number of results per page (default: 50, max: 100)

Minimum: 1Maximum: 100

emailstring

Filter by customer email address

Minimum length: 1

phonestring

Filter by customer phone number

Minimum length: 1

customerIdstring

Filter by specific customer ID

Minimum length: 1

typeunknown

Filter by customer type

Value in: "individual" | "business"

createdFromstring

Filter customers created on or after this date (ISO 8601)

Format: "date"

createdTostring

Filter customers created on or before this date (ISO 8601)

Format: "date"

Response Body

The customers were retrieved successfully

customersRequiredarray<object>

paginationRequiredobject

export interface Response {
  customers: {
    /**
     * A unique identifier for the customer
     */
    id: string;
    /**
     * The type of customer: individual or business
     */
    type: "individual" | "business";
    /**
     * The first name of the customer
     */
    firstName?: string | null;
    /**
     * The middle name of the customer
     */
    middleName?: string | null;
    /**
     * The last name of the customer
     */
    lastName?: string | null;
    /**
     * The legal name of the business (for business customers)
     */
    legalName?: string | null;
    /**
     * The website URL of the business (for business customers)
     */
    website?: string | null;
    /**
     * The primary email address of the customer
     */
    email: string;
    /**
     * The primary phone number of the customer in E.164 format (e.g., +1234567890)
     */
    phone: string;
    /**
     * The date of birth of the customer in ISO 8601 format (YYYY-MM-DD)
     */
    birthDate?: string | null;
    /**
     * The country of the customer (ISO 3166-1 alpha-2 or alpha-3 code)
     */
    country?: string | null;
    /**
     * The KYC verification status of the customer
     */
    status: "not_started" | "incomplete" | "under_review" | "approved" | "rejected" | "pending_verification";
    /**
     * The provided metadata of the customer
     */
    metadata?: {
      [k: string]: string | number | boolean;
    } | null;
    /**
     * Array of customer wallet addresses (only present in legacy mode)
     */
    walletAddresses?: string[];
    /**
     * The total balance of the customer in USD
     */
    balance: number;
    /**
     * The date and time the customer was created
     */
    createdAt: string;
    /**
     * The date and time the customer was last updated
     */
    updatedAt: string;
  }[];
  pagination: {
    page: number;
    limit: number;
    total: number;
    totalPages: number;
    hasMore: boolean;
  };
}

curl -X GET "https://wallet.swipelux.com/v1/customers?page=1&limit=1&email=string&phone=string&customerId=string&type=individual&createdFrom=2019-08-24&createdTo=2019-08-24" \
  -H "X-API-Key: <token>"

{
  "customers": [
    {
      "id": "string",
      "type": "individual",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "legalName": "string",
      "website": "string",
      "email": "user@example.com",
      "phone": "string",
      "birthDate": "2019-08-24",
      "country": "str",
      "status": "not_started",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "walletAddresses": [
        "string"
      ],
      "balance": 0,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0,
    "hasMore": true
  }
}