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.
startDatestring<date><p>Start date for date-range filtering. Returns segments with dates on or after the specified value.</p>
endDatestring<date><p>End date for date-range filtering. Returns segments with dates on or before this value.</p>
usedInTypestring<p>Filter by usage type using a DataReleaseItemType data code. Returns segments used within a specified context, such as a bonus or promotion rule.</p>
usedInNamestringFilter by usage name. Returns segments used within a specific context whose name matches the provided value.
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 \
--header 'accept: application/json'