List Business Loyalty Plans
API operation: Open the endpoint in Scalar
Use GET /loyalty_plans/{loyalty_plan_id}/businesses to list the business-specific settings associated with a loyalty plan. The operation is BusinessLoyaltyPlan.findAll.
The operation requires administrator authentication. Each returned item identifies a business and can include accumulation, redemption, maximum, and expiration overrides.
For the surrounding resource concepts, see Business loyalty plans model.
OpenAPI reference
Operation: GET /loyalty_plans/{loyalty_plan_id}/businesses
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
loyalty_plan_id | integer | Yes | — |
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. |
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 |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |