v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Loyalty

Get Loyalty Program Customers

List Loyalty Program Customers

Retrieves a list of customers associated with a specific loyalty program.

Path Parameters:

  • programId: UUID of the loyalty program

Query Parameters:

  • phone: Filter by customer's phone number (optional)
  • email: Filter by customer's email (optional)
  • pid: Filter by personal identifier (optional)
  • pidNumber: Filter by personal identifier number (optional)
  • includeTotal: Include total member count in response (default: false)

Returns:

  • By default: A list of customer details as JSON objects.
  • If includeTotal=true: An object with customers array and total count.
get/v2/loyalty/programs/{programId}/customers

Path parameters

string required
OR
string required
Example:5eb7cf5a86d9755df3a6c593

Query parameters

phonestring nullable
emailstring nullable
pidstring nullable
pidNumberstring nullable
orderBystring nullable
byNameboolean nullable
qstring nullable
pageinteger
limitinteger
offsetinteger nullable

Headers

authorizationstring nullable

Response

Successful Response

{"stackTrail":"paths:/v2/loyalty/programs/{programId}/customers:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}