Get
curl --request GET \
--url https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id} \
--header 'Authorization: Bearer <token>'const url = 'https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}using RestSharp;
var options = new RestClientOptions("https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.get("https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id}")
.header("Authorization", "Bearer <token>")
.asString();{
"entityId": "8dfd708c-9584-4ed3-8e2c-415afb373a13",
"firstname": {
"from": "pms",
"value": "Martin",
"updated": "2023-03-09T13:19:40+00:00"
},
"pmsId": {
"from": "pms",
"value": {
"id": "139569",
"pms": "protelio"
},
"updated": "2023-03-09T13:19:40+00:00"
},
"type": "guest",
"optedOut": {
"prestay": {
"from": "agent",
"value": false,
"updated": "2023-03-09T13:19:40+00:00"
},
"marketing": {
"from": "guest",
"value": true,
"updated": "2023-03-09T13:19:40+00:00"
}
},
"socials": {
"avatar": {
"from": "agent",
"value": "https://www.example.com/avatars/martin-dupont.png",
"updated": "2023-03-09T13:19:40+00:00"
},
"twitter": {
"from": "system",
"value": {
"url": "https://twitter.com/example",
"followers": 500
},
"updated": "2023-03-09T13:19:40+00:00"
},
"website": {
"from": "system",
"value": "https://www.example.com",
"updated": "2023-03-09T13:19:40+00:00"
},
"linkedin": {
"from": "system",
"value": {
"url": "https://www.linkedin.com/in/example"
},
"updated": "2023-03-09T13:19:40+00:00"
}
},
"lastname": {
"from": "pms",
"value": "Dupont",
"updated": "2023-03-09T13:19:40+00:00"
},
"birthplace": {
"from": "pms",
"value": {
"city": "La Rochelle",
"country": "FR",
"zipcode": "17000"
},
"updated": "2023-03-09T13:19:40+00:00"
},
"extra": "3ef1a024-8293-49c8-b17f-24bb96c9f50e",
"loyalty": {
"from": "guest",
"value": {
"id": "123456789",
"points": 107,
"status": "gold",
"program": "hotelrewards"
},
"updated": "2023-03-09T13:19:40+00:00"
},
"phones": [
{
"value": {
"phone": "+33600000000",
"countryCode": "FR",
"internationalFormat": "+33 6 00 00 00 00",
"nationalFormat": "06 00 00 00 00",
"type": "mobile"
},
"from": "guest",
"preferred": true
}
],
"languages": [
{
"from": "guest",
"value": "fr",
"updated": "2023-03-09T13:19:40+00:00"
},
{
"from": "guest",
"value": "es",
"updated": "2023-03-09T13:19:40+00:00",
"preferred": true
}
],
"title": {
"from": "pms",
"value": "MRS",
"updated": "2023-03-09T13:19:40+00:00"
},
"notes": [
{
"value": "Prefers a quiet room away from the lift.",
"from": "agent"
}
],
"gender": {
"from": "system",
"value": "M",
"updated": "2023-03-09T13:19:40+00:00"
},
"addresses": [
{
"from": "guest",
"value": {
"city": "Ramonville Saint-Agne",
"state": "Occitanie",
"street": "12 avenue de l'Europe",
"country": "FR",
"zipcode": "31520"
},
"updated": "2023-03-09T13:19:40+00:00"
},
{
"from": "agent",
"value": {
"city": "Paris",
"state": "Ile-De-France",
"street": "21 rue de Rocroy",
"country": "FR",
"zipcode": "75000"
},
"updated": "2023-03-09T13:19:40+00:00",
"preferred": true
}
],
"nationalities": [
{
"from": "guest",
"value": "FR",
"updated": "2023-03-09T13:19:40+00:00"
},
{
"from": "guest",
"value": "ES",
"updated": "2023-03-09T13:19:40+00:00",
"preferred": true
}
],
"company": {
"from": "guest",
"value": {
"title": "Web developer",
"company": "D-EDGE CRM"
},
"updated": "2023-03-09T13:19:40+00:00"
},
"middlename": {
"from": "guest",
"value": "Fitzgerlad",
"updated": "2023-03-09T13:19:40+00:00"
},
"id": "ef779d32-deca-4bd1-853d-07987e82027c",
"createdAt": "2023-03-09T13:19:40.000000Z",
"birthdate": {
"from": "guest",
"value": {
"birthdate": "1987-02-20"
},
"updated": "2023-03-09T13:19:40+00:00"
},
"emails": [
{
"value": {
"email": "martin.dupont@example.com"
},
"from": "pms",
"preferred": true
}
],
"composedWith": []
}
Guest
Get a guest
Read a guest profile by identifier
GET
/
api
/
guestprofile
/
entities
/
{entity_id}
/
guests
/
{guest_id}
Get
curl --request GET \
--url https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id} \
--header 'Authorization: Bearer <token>'const url = 'https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}using RestSharp;
var options = new RestClientOptions("https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.get("https://{apiBaseUrl}/api/guestprofile/entities/{entity_id}/guests/{guest_id}")
.header("Authorization", "Bearer <token>")
.asString();{
"entityId": "8dfd708c-9584-4ed3-8e2c-415afb373a13",
"firstname": {
"from": "pms",
"value": "Martin",
"updated": "2023-03-09T13:19:40+00:00"
},
"pmsId": {
"from": "pms",
"value": {
"id": "139569",
"pms": "protelio"
},
"updated": "2023-03-09T13:19:40+00:00"
},
"type": "guest",
"optedOut": {
"prestay": {
"from": "agent",
"value": false,
"updated": "2023-03-09T13:19:40+00:00"
},
"marketing": {
"from": "guest",
"value": true,
"updated": "2023-03-09T13:19:40+00:00"
}
},
"socials": {
"avatar": {
"from": "agent",
"value": "https://www.example.com/avatars/martin-dupont.png",
"updated": "2023-03-09T13:19:40+00:00"
},
"twitter": {
"from": "system",
"value": {
"url": "https://twitter.com/example",
"followers": 500
},
"updated": "2023-03-09T13:19:40+00:00"
},
"website": {
"from": "system",
"value": "https://www.example.com",
"updated": "2023-03-09T13:19:40+00:00"
},
"linkedin": {
"from": "system",
"value": {
"url": "https://www.linkedin.com/in/example"
},
"updated": "2023-03-09T13:19:40+00:00"
}
},
"lastname": {
"from": "pms",
"value": "Dupont",
"updated": "2023-03-09T13:19:40+00:00"
},
"birthplace": {
"from": "pms",
"value": {
"city": "La Rochelle",
"country": "FR",
"zipcode": "17000"
},
"updated": "2023-03-09T13:19:40+00:00"
},
"extra": "3ef1a024-8293-49c8-b17f-24bb96c9f50e",
"loyalty": {
"from": "guest",
"value": {
"id": "123456789",
"points": 107,
"status": "gold",
"program": "hotelrewards"
},
"updated": "2023-03-09T13:19:40+00:00"
},
"phones": [
{
"value": {
"phone": "+33600000000",
"countryCode": "FR",
"internationalFormat": "+33 6 00 00 00 00",
"nationalFormat": "06 00 00 00 00",
"type": "mobile"
},
"from": "guest",
"preferred": true
}
],
"languages": [
{
"from": "guest",
"value": "fr",
"updated": "2023-03-09T13:19:40+00:00"
},
{
"from": "guest",
"value": "es",
"updated": "2023-03-09T13:19:40+00:00",
"preferred": true
}
],
"title": {
"from": "pms",
"value": "MRS",
"updated": "2023-03-09T13:19:40+00:00"
},
"notes": [
{
"value": "Prefers a quiet room away from the lift.",
"from": "agent"
}
],
"gender": {
"from": "system",
"value": "M",
"updated": "2023-03-09T13:19:40+00:00"
},
"addresses": [
{
"from": "guest",
"value": {
"city": "Ramonville Saint-Agne",
"state": "Occitanie",
"street": "12 avenue de l'Europe",
"country": "FR",
"zipcode": "31520"
},
"updated": "2023-03-09T13:19:40+00:00"
},
{
"from": "agent",
"value": {
"city": "Paris",
"state": "Ile-De-France",
"street": "21 rue de Rocroy",
"country": "FR",
"zipcode": "75000"
},
"updated": "2023-03-09T13:19:40+00:00",
"preferred": true
}
],
"nationalities": [
{
"from": "guest",
"value": "FR",
"updated": "2023-03-09T13:19:40+00:00"
},
{
"from": "guest",
"value": "ES",
"updated": "2023-03-09T13:19:40+00:00",
"preferred": true
}
],
"company": {
"from": "guest",
"value": {
"title": "Web developer",
"company": "D-EDGE CRM"
},
"updated": "2023-03-09T13:19:40+00:00"
},
"middlename": {
"from": "guest",
"value": "Fitzgerlad",
"updated": "2023-03-09T13:19:40+00:00"
},
"id": "ef779d32-deca-4bd1-853d-07987e82027c",
"createdAt": "2023-03-09T13:19:40.000000Z",
"birthdate": {
"from": "guest",
"value": {
"birthdate": "1987-02-20"
},
"updated": "2023-03-09T13:19:40+00:00"
},
"emails": [
{
"value": {
"email": "martin.dupont@example.com"
},
"from": "pms",
"preferred": true
}
],
"composedWith": []
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
If the guest is merged, redirect=false will force to return the original guest (default is true)
Return the source profiles of a merged guest in full. Without it, composedWith holds their identifiers; with it, it holds the profiles themselves.
Response
The guest
Kind of profile. A profile produced by a merge carries merge, and reading one of its sources returns it.
Available options:
guest, extra, merge Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
When the guest is merged, this property holds all guests IDs who compose the guest
Was this page helpful?