Get segment members

1 min

GET

https://api.b.preview.loyaltyservices.io/api/v3/segments/{segmentCode}/members

Returns current members of the segment in either JSON or CSV format based on the Accept header. For LIMITED_TIME segments, Start Date, End Date, and Member Segment Status are included. For all other segment types only Member Name and Account Number are returned. JSON responses are paginated. CSV responses stream the full membership. Both api:segment

and api:member

scopes are required (AND).

segmentCodestringSegment code

accountNumberstringFilter by account number

startDatestring<date>Filter by start date (LIMITED_TIME segments only). Format YYYY-MM-DD.

endDatestring<date>Filter by end date (LIMITED_TIME segments only). Format YYYY-MM-DD.

memberSegmentStatusstringFilter by member segment status (LIMITED_TIME segments only).

pageNumberintegerPage number (1-indexed, default 1)

pageSizeintegerNumber of items per page (default 500, max 500)

acceptstringGenerated from available response content types

200Successful operation

400Bad request. Returned when pageSize exceeds 500, or when startDate, endDate, or memberSegmentStatus filters are used on a non-LIMITED_TIME segment.

401Unauthorized

403Forbidden

404Not found

500Internal error

curl --request GET \
     --url 'https://api.b.preview.loyaltyservices.io/api/v3/segments/{segmentCode}/members?pageNumber=1&pageSize=500' \
     --header 'accept: application/json'