Find segments
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/segments
Query Parameters
- segmentNamestringExampleDescription
- segmentCodestringExampleDescription
- excludeTypeCodestring[]ExampleDescription
- statusCodestringExampleDescription
- startDatestring<date>ExampleDescriptionFormatdate
- endDatestring<date>ExampleDescriptionFormatdate
- usedInTypestringExampleDescription
- usedInNamestringExampleDescription
Responses
200
- Segment[]Description
- segmentIdinteger<int64>DescriptionFormatint64
- codestringDescription
- namestringDescription
- descriptionstringDescription
- statusCodestringDescription
- typeCodestringDescription
- expirationDaysintegerDescription
- ownerNamestringDescription
- displayInCCbooleanDescription
400
- ErrorResponse
- errorsValidationError[]Description
- codestringDescription
- fieldNamestringDescription
- messagestringDescription
- messageParametersobject[]Description
401
403
500
curl
curl --request GET \
--url https://api.b.preview.loyaltyservices.io/api/v3/segments \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.b.preview.loyaltyservices.io/api/v3/segments", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.b.preview.loyaltyservices.io/api/v3/segments")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.b.preview.loyaltyservices.io/api/v3/segments"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Success
[
{
"segmentId": "",
"code": "",
"name": "",
"description": "",
"statusCode": "",
"typeCode": "",
"expirationDays": 0,
"ownerName": "",
"displayInCC": false
}
]400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error