Customer List

Please note that the customer data returned may not be complete. You will need to call the Get Customer Detail API to retrieve more detailed information.

Get Customer List

GET /customer

This endpoint retrieves a list of customers with optional filtering.

Headers

Name
Value

Accept

application/json

Authorization

Bearer <token>

Params

Name
Type
Description

client_code

string

Client identifier

limit

number

Total record to be displayed [Optional, Integer, Default: 10]

page

number

Current Page [Optional, Integer, Default: 1]

barcode

string

Barcode Number [Optional, Numeric]

phone

string

Phone Number [Optional, Numeric]

id_number

string

Identity Number [Optional]

Response

{
    "status": "success",
    "status_code": 200,
    "data": {
        "id": 109905,
        "code": "0000000003",
        "barcode": "0000000012",
        "name": "Girein",
        "id_number": "1234567890123455",
        "profile_picture": null,
        "active": true,
        "expired_at": "2025-10-08 09:19:56",
        "total_expense": 3150000,
        "point": {
            "redeem": 10,
            "lucky_draw": 0
        },
        "referral_code": "GIRDQZJU",
        "birth_place": "Jakarta",
        "birth_date": "1995-08-09",
        "gender": "M",
        "marital_status": "Single",
        "religion": "Catholic",
        "blood": "Others",
        "crypto_address": null,
        "ig_username": null,
        "preferred_contact": "Both",
        "phone": {
            "mobile": "6281298983778",
            "home": null,
            "business": null
        },
        "facsimile": null,
        "email": "[email protected]",
        "id_type": {
            "id": 360,
            "code": "001",
            "name": "KTP"
        },
        "card_type": {
            "id": 202,
            "name": "REGULAR CARD",
            "target_amount": 0,
            "minimum_expense": 0,
            "multiplier_point": 1,
            "expired_period": 9999,
            "level_up_evaluation_days": 365,
            "level_down_evaluation_days": 365,
            "default": true,
            "active": true,
            "image": null,
            "benefits": []
        },
        "nationality": {
            "id": 1112,
            "code": "999",
            "name": "Others"
        },
        "occupation": {
            "id": 1799,
            "code": "999",
            "name": "Others"
        },
        "address": {
            "id": 93289,
            "address": "Gunung Sahari",
            "zip_code": "10610",
            "default": true,
            "country": {
                "id": 1,
                "name": "Indonesia"
            },
            "province": {
                "id": 31,
                "name": "Dki Jakarta"
            },
            "city": {
                "id": 153,
                "name": "Kab. Kepulauan Seribu"
            },
            "village": null
        }
    }
}

On the Customers page, ensure that you have selected the desired unique identity, either a phone number or an email address. Once you have made this selection, you can proceed to access the relevant API.

This unique identifier will be used to retrieve or manage customer information effectively.

Last updated