Customers

List customers

Retrieves a paginated list of customers enrolled in your company's loyalty program. Use max and offset parameters to paginate through results.

get/customers

Query parameters

maxinteger

Limit results size.

offsetinteger

Paginate results by given offset.

cursorstring

Paginate results by cursor.

Response

Paginated list of company customers.

Example response

{
  "rows": [
    {
      "uid": "23684cea-ca50-4c5c-b399-eb473e85b5ad",
      "avatar": "https://cdn.uds.app/avatars/user123.jpg",
      "displayName": "John Doe",
      "gender": "MALE",
      "phone": "+12125551234",
      "birthDate": "1990-05-15",
      "email": "john.doe@example.com",
      "channelName": "Website",
      "participant": {
        "id": 789,
        "inviterId": 456,
        "points": 350.5,
        "discountRate": 7,
        "cashbackRate": 7,
        "cashSpent": 1250,
        "savedFunds": 125,
        "invitedCount": 3,
        "effectiveInvitedCount": 2,
        "operationsCount": 15,
        "fullRefundsCount": 0,
        "note": "Regular customer",
        "membershipTier": {
          "uid": "silver-tier",
          "name": "Silver",
          "rate": 7
        },
        "dateCreated": "2023-01-15T10:30:00.000Z",
        "lastTransactionTime": "2024-11-20T14:22:00.000Z"
      }
    }
  ],
  "total": 1
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.