Find Users
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/users
Query Parameters
- pageNumberintegerExampleDescriptionDefault1Minimum1
- pageSizeintegerExampleDescriptionDefault500Minimum1Maximum500
Responses
200
- FindUsersResponse
- usersUserSummary[]required
- userIdinteger<int64>DescriptionFormatint64
- displayNamestringDescription
- pageInfoPageInforequired
- numberintegerDescription
- sizeintegerDescription
- totalItemsintegerDescription
- hasNextbooleanDescription
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/users?pageNumber=1&pageSize=500' \
--header 'accept: application/json'ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.b.preview.loyaltyservices.io/api/v3/users?pageNumber=1&pageSize=500")
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/users?pageNumber=1&pageSize=500"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://api.b.preview.loyaltyservices.io/api/v3/users?pageNumber=1&pageSize=500")
.method("GET", body)
.addHeader("accept", "application/json")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();200
// Success
{
"users": [
{
"userId": "",
"displayName": ""
}
],
"pageInfo": {
"number": 0,
"size": 0,
"totalItems": 0,
"hasNext": false
}
}400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal Server Error