Lister les préférences CRM d'un client

GET

/v1/guests/{id}/preferences

const url = 'https://example.com/v1/guests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preferences';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/guests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preferences \
  --header 'X-API-Key: <X-API-Key>'

Retourne les préférences posées pour ce client, jointes au référentiel (label, catégorie). Liste vide si le profil est anonymisé (RGPD art.17).

Authorizations

ApiKeyAuth
BearerAuth

Parameters

Path Parameters

required

string format: uuid

UUID du profil guest

Responses

200

Préférences du client

application/json

object

data

required

Array<object>

object

preferenceKeyId

required

string format: uuid

code

required

string

label

required

string

category

required

string

Allowed values: stay accessibility arrival camping

valueType

required

string

Allowed values: text integer boolean enum

displayValue

required

string

source

required

string

Allowed values: staff guest_self imported inferred

notedAt

required

string format: date-time

notedBy

string format: uuid

nullable

Example

{
  "data": [
    {
      "category": "stay",
      "valueType": "text",
      "source": "staff"
    }
  ]
}

404

Profil guest introuvable

application/json

object

code

required

Code machine de l’erreur

string

message

required

Message lisible

string

origin

Origine domaine de l’erreur (optionnel)

object

boundedContext

string

module

string

status

required

integer

traceId

required

Identifiant de corrélation pour le support

string

Example

{
  "code": "RESERVATION_NOT_FOUND",
  "message": "Réservation introuvable",
  "status": 404
}