Find communication types
1 min
GET
https://api.b.preview.loyaltyservices.io/api/v3/communication-types
Query Parameters
- namestringExampleDescription
- channelstringExampleDescriptionAllowedEmailSMS
- statusCodestringExampleDescription
- pageNumberintegerExampleDescriptionDefault1Minimum1
- pageSizeintegerExampleDescriptionDefault50Minimum1Maximum500
Responses
200
- FindCommunicationTypesResponse
- communicationTypesCommunicationType[]required
- codestringrequiredExampleDescriptionMax Length50
- namestringrequiredExampleDescriptionMax Length100
- descriptionstringExampleDescriptionMax Length500
- channelstring<Email | SMS>requiredExampleDescriptionAllowedEmailSMS
- providerCodestringrequiredExampleDescriptionMax Length50
- externalCodestringrequiredExampleDescriptionMax Length100
- statusCodestringrequiredExampleDescriptionMax Length50
- 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/communication-types?pageNumber=1&pageSize=50' \
--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/communication-types?pageNumber=1&pageSize=50", 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/communication-types?pageNumber=1&pageSize=50")
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/communication-types?pageNumber=1&pageSize=50"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Success
{
"communicationTypes": [
{
"code": "WELCOME_EMAIL",
"name": "Welcome Email",
"description": "Sent when a member enrolls",
"channel": "Email",
"providerCode": "Braze",
"externalCode": "d-abc123",
"statusCode": "Active"
}
],
"pageInfo": {
"number": 0,
"size": 0,
"totalItems": 0,
"hasNext": false
}
}400
// Bad request
{
"errors": [
{
"code": "",
"fieldName": "",
"message": "",
"messageParameters": [
{}
]
}
]
}401
// Unauthorized
403
// Forbidden
500
// Internal error