Swipelux
Customer API

Get all customers

Retrieve all customers

GET
/v1/customers

Authorization

X-API-Key<token>

In: header

Query Parameters

pageinteger
Minimum: 1
limitinteger
Minimum: 1Maximum: 100
emailstring
Minimum length: 1
phonestring
Minimum length: 1
customerIdstring
Minimum length: 1
createdFromstring
Format: "date"
createdTostring
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 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 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 KYC verification status of the customer
     */
    status: "not_started" | "incomplete" | "under_review" | "approved" | "rejected";
    /**
     * 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 creation date of the customer
     */
    createdAt: string;
    /**
     * The last update date of the customer
     */
    updatedAt: string;
    /**
     * Helpful suggestions for next API calls
     */
    hints?: {
      /**
       * Action description
       */
      description: string;
      /**
       * HTTP request details
       */
      request: {
        /**
         * HTTP method
         */
        method: string;
        /**
         * API endpoint URL
         */
        url: string;
        /**
         * Request body with placeholders
         */
        body?: {
          [k: string]: unknown;
        };
      };
    }[];
  }[];
  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&createdFrom=2019-08-24&createdTo=2019-08-24" \
  -H "X-API-Key: <token>"
{
  "customers": [
    {
      "id": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "email": "user@example.com",
      "phone": "string",
      "status": "not_started",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "walletAddresses": [
        "string"
      ],
      "balance": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "hints": [
        {
          "description": "string",
          "request": {
            "method": "string",
            "url": "string",
            "body": null
          }
        }
      ]
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0,
    "hasMore": true
  }
}