List loyalty program rows
Identity module
GET/loyalty-programsloyaltyPrograms.list
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 a cursor page of loyalty program rows the caller may see. The default order is `sort_order`, then `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability me.work_details.write.
- OAuth scopes: me.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of LoyaltyProgram
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the loyalty program. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| person_id | string (uuid) | Yes | Identifier of the person the program belongs to; always the caller. |
| program_kind | LoyaltyProgramKind | Yes | Kind of travel loyalty program.Constraints: one of "Airline", "Hotel", "Car Rental", "Rail" |
| program_name | string | Yes | Program.Constraints: length 1 to 100 |
| member_number | string | Yes | Membership number.Constraints: length 1 to 40 |
| sort_order | integer | Yes | Display order.Constraints: range 0 to any |
{
"data": [
{
"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
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/loyalty-programs" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.loyaltyPrograms.listAll()) {
console.log(row);
}for row in xos.loyalty_programs.list_all():
print(row)xos loyalty-programs list --all