List Loyalty Plans
API operation: Open the endpoint in Scalar
Use GET /loyalty_plans to list loyalty plans. The operation is LoyaltyPlan.findAll.
The operation exposes this collection read without authentication. Returned plans can include type, accumulation, redemption, maximum, expiration, and business-assignment information.
See Loyalty plan model for the resource concepts.
OpenAPI reference
Operation: GET /loyalty_plans
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
params | string | No | Comma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields. |
orderBy | string | No | Field to sort by, with - prefixed for descending order. Multiple fields can be chained with commas. |
where | string | No | JSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension. |
page | integer | No | Page number, starting at 1. Applies only to lists that return a pagination block. |
page_size | integer | No | Number of items per page. |
Responses
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized (ProjectAccessErrorResponse) |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |