Skip to main content

List Loyalty Levels

API operation: Open the endpoint in Scalar

Use GET /loyalty_levels to list loyalty levels. The operation is LoyaltyLevel.findAll.

The operation exposes this collection read without authentication. Returned levels can describe point thresholds, accumulation, benefits, expiration, and presentation settings.

See Loyalty levels model for the resource concepts.

OpenAPI reference​

Operation: GET /loyalty_levels

Query parameters

NameTypeRequiredDescription
paramsstringNoComma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields.
orderBystringNoField to sort by, with - prefixed for descending order. Multiple fields can be chained with commas.
wherestringNoJSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension.
pageintegerNoPage number, starting at 1. Applies only to lists that return a pagination block.
page_sizeintegerNoNumber of items per page.

Responses

CodeDescription
200OK
400Bad Request (ErrorResponse)
401Unauthorized (ProjectAccessErrorResponse)
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference