Skip to content
Nexus Docs

List active rental items

GET
/api/public/{slug}/rental-items
curl --request GET \
  --url https://example.com/api/public/example/rental-items

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
description
required
Any of:
string
dailyRateCents
required
integer
>= -9007199254740991 <= 9007199254740991
pricingUnit
required
string
minPeriod
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
maxPeriod
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
totalQuantity
required
integer
>= -9007199254740991 <= 9007199254740991
depositCents
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
deliveryAvailable
required
boolean
deliveryFeeCents
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
cleaningFeeCents
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
imageUrl
required
Any of:
string
Examplegenerated
{
  "data": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "description": "example",
      "dailyRateCents": 1,
      "pricingUnit": "example",
      "minPeriod": 1,
      "maxPeriod": 1,
      "totalQuantity": 1,
      "depositCents": 1,
      "deliveryAvailable": true,
      "deliveryFeeCents": 1,
      "cleaningFeeCents": 1,
      "imageUrl": "example"
    }
  ]
}