Find segments
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/segments
segmentNamestringFilter by segment name. Performs a wildcard search and returns segments whose names contain the specified value.
segmentCodestringFilter by segment code. Performs a wildcard search and returns segments whose codes contain the specified value.
excludeTypeCodearrayExclude specific segment types using one or more SegmentType data codes. Segments matching any of the specified types will be excluded from the results.
statusCodestringFilter by segment status using a SegmentStatus data code.
pageNumberinteger<p>Page number (1-indexed, default 1)</p>
pageSizeinteger<p>Number of items per page (default 500, max 500)</p>
acceptstringGenerated from available response content types
200Success
400Bad request
401Unauthorized
403Forbidden
500Internal error
curl --request GET \
--url 'https://api.b.preview.loyaltyservices.io/api/v3/segments?pageNumber=1&pageSize=500' \
--header 'accept: application/json'