API overview
List active products
Choose an operation to see its request, response shape, access rules and implementation source.
ReadPublic
GET/api/v1/products
List active products
No auth:sanctum or bearer ability is required by this route.
Request
| Field | In | Rule |
|---|---|---|
q | Query string | Optional string; searches name/description at 2+ trimmed characters. |
category | Query string | Optional category slug or ID. |
page | Query string | Optional page number; default 1. No per_page or sort override. |
No request body.
curl --request GET "https://shop.example.test/api/v1/products" \
--header 'Accept: application/json' \
--get \
--data-urlencode 'q=lamp' \
--data-urlencode 'category=lighting' \
--data-urlencode 'page=1'Response200
Success: 200
Response shape (notation, not a captured response)
{ data: Product[], links, meta }Common errors
| HTTP status | Meaning |
|---|---|
429 | rate_limited: back off before retrying, especially writes. |