Get a loyalty program
Módulo Identity
GET/loyalty-programs/{id}loyaltyPrograms.get
A travel loyalty program the caller belongs to, at most twenty (422 loyalty_program_limit). A program name appears once per kind (409). Shared with an engagement under the Travel Profile category. Returns one loyalty program with its `ETag`. A loyalty program the caller may not see returns 404.
- Requiere la capacidad me.work_details.write.
- Alcances de OAuth: me.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the loyalty program. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: LoyaltyProgram
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the loyalty program. |
| created_at | string (date-time) | Sí | When the row was created. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| person_id | string (uuid) | Sí | Identifier of the person the program belongs to; always the caller. |
| program_kind | LoyaltyProgramKind | Sí | Kind of travel loyalty program.Restricciones: one of "Airline", "Hotel", "Car Rental", "Rail" |
| program_name | string | Sí | Program.Restricciones: length 1 to 100 |
| member_number | string | Sí | Membership number.Restricciones: length 1 to 40 |
| sort_order | integer | Sí | Display order.Restricciones: range 0 to any |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"program_kind": "Airline",
"program_name": "SkyMiles",
"member_number": "SM-0000-TEST",
"sort_order": 0
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/loyalty-programs/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.loyaltyPrograms.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.loyalty_programs.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos loyalty-programs get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f