Skip to main content
GET
/
customers
/
search
Search Customer
curl --request GET \
  --url https://webmaster.zupers.com.br/api/loyalty/v1/customers/search/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 1,
  "page": 1,
  "per_page": 20,
  "total_pages": 1,
  "results": [
    {
      "id": "cust_1234567890",
      "card_number": "ZUP001234567",
      "user": {
        "name": "João Silva",
        "email": "[email protected]",
        "whatsapp_number": "+5511999999999",
        "cpf": "12345678901"
      },
      "points_balance": 1250,
      "points_earned": 5780,
      "points_spent": 4530,
      "tier": "Gold",
      "active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "last_activity_date": "2023-11-07T05:31:56Z",
      "transaction_count": 47,
      "loyalty_program": {
        "program_name": "Miola Rewards",
        "currency_name": "ZupCoins",
        "currency_symbol": "ZC"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use format: Bearer ZsCUqECc9aCQtN5z9z9sTs81933YnklP

Query Parameters

​
q
string

Search query - phone number or email address

Example:

"11999999999"

​
search_type
enum<string>

Specific search type when used with q parameter

Available options:
name,
email,
phone,
cpf,
customer_code
​
phone
string

Search by phone number (digits only)

Example:

"5511965958122"

​
email
string<email>

Search by email address

Example:

"[email protected]"

​
cpf
string

Search by CPF (with or without formatting)

Example:

"12345678901"

​
customer_code
string

Search by customer code (card number)

Example:

"ZP-4F95FB0A"

​
page
integer
default:1

Page number for pagination

​
per_page
integer
default:20

Items per page (max 100)

Required range: x <= 100

Response

Search completed successfully

​
count
integer
Example:

1

​
page
integer
Example:

1

​
per_page
integer
Example:

20

​
total_pages
integer
Example:

1

​
results
object[]