Skip to Content
rentall API byla vydána 🎉
ProductsGET /api/products

title: GET /api/products description: Výpis produktů se stránkováním, filtrováním a řazením.

GET /api/products

  • URL: /api/products
  • Metoda: GET
  • Autorizace: dle projektu
  • Vrací: stránkovaný seznam objektů Product

Tento endpoint Rentall API vrací seznam produktů pro konkrétního pronajímatele nebo globálně — dle přístupových pravidel.

Parametry dotazu

  • page — číslo (výchozí 1)
  • limit — číslo (výchozí 10)
  • sort — název pole, volitelně s - pro sestupně (např. -createdAt, basic.product_name)
  • where — JSON objekt s filtry dle konvencí Rentall (např. { "settings.published": { "equals": true } })

Příklady:

  • GET /api/products?limit=20&sort=-createdAt
  • GET /api/products?where={"settings.published":{"equals":true}}

Úspěšná odpověď

  • Stav: 200 OK
  • Tělo: stránkovaný výsledek
{ "docs": [ { "id": "68b5b692be9080affaa098c3", "basic": { "product_name": "Example Product", "location": "Example City" }, "additional": { "price": 500, "caution": 1000, "time_unit": "day" }, "settings": { "published": true, "slug": "example-product" }, "createdAt": "2025-09-01T15:06:58.847Z", "updatedAt": "2025-09-01T15:07:09.125Z" } ], "hasNextPage": false, "limit": 10, "page": 1, "totalDocs": 1, "totalPages": 1 }

Chyby

  • 401/403 při chybějícím/zakázaném přístupu

Příklady

curl -s \ -H "Authorization: Bearer $RENTALL_TOKEN" \ "https://rentall.cz/api/products?limit=20&sort=-createdAt"