Skip to main content
GET
/
rentals
curl -X GET "https://api.example.com/rentals?page=0&size=10&sort=loanDate,desc" \
  -u "username:password" \
  -H "Content-Type: application/json"
{
  "content": [
    {
      "id": 123,
      "user": {
        "id": 42,
        "firstname": "John",
        "lastname": "Doe",
        "email": "[email protected]",
        "displayPicture": "https://example.com/photos/john.jpg"
      },
      "book": {
        "isbn": "978-0-12345-678-9",
        "title": "The Great Adventure",
        "stock": 4,
        "coverImage": "https://example.com/covers/great-adventure.jpg",
        "author": {
          "id": 7,
          "name": "Jane Smith",
          "age": 45
        }
      },
      "loanDate": "2026-03-04T10:30:00Z",
      "returnDate": "2026-03-18T10:30:00Z",
      "returned": false
    }
  ],
  "pageable": {
    "pageNumber": 0,
    "pageSize": 10,
    "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
    },
    "offset": 0,
    "paged": true,
    "unpaged": false
  },
  "totalElements": 1,
  "totalPages": 1,
  "last": true,
  "first": true,
  "size": 10,
  "number": 0,
  "numberOfElements": 1,
  "empty": false
}

Authentication

This endpoint requires HTTP Basic Authentication.

Query Parameters

page
integer
default:"0"
Page number (0-indexed)
size
integer
default:"20"
Number of rentals per page
sort
string
Sort field and direction (e.g., loanDate,desc or id,asc)

Response

content
array
Array of rental objects
id
integer
Unique identifier for the rental
user
object
User who rented the book
id
integer
User ID
firstname
string
User’s first name
lastname
string
User’s last name
email
string
User’s email address
displayPicture
string
URL to user’s display picture
book
object
Book being rented
isbn
string
Book ISBN
title
string
Book title
stock
integer
Current stock count
coverImage
string
URL to book cover image
author
object
Book author details
id
integer
Author ID
name
string
Author name
age
integer
Author age
loanDate
string
ISO 8601 timestamp when the book was rented
returnDate
string
ISO 8601 timestamp when the book is due
returned
boolean
Whether the book has been returned
pageable
object
Pagination metadata
pageNumber
integer
Current page number (0-indexed)
pageSize
integer
Number of items per page
sort
object
Sort information
offset
integer
Offset of the first item
paged
boolean
Whether the results are paged
unpaged
boolean
Whether the results are unpaged
totalElements
integer
Total number of rentals across all pages
totalPages
integer
Total number of pages
last
boolean
Whether this is the last page
first
boolean
Whether this is the first page
size
integer
Number of items per page
number
integer
Current page number (0-indexed)
numberOfElements
integer
Number of items in the current page
empty
boolean
Whether the current page is empty
curl -X GET "https://api.example.com/rentals?page=0&size=10&sort=loanDate,desc" \
  -u "username:password" \
  -H "Content-Type: application/json"
{
  "content": [
    {
      "id": 123,
      "user": {
        "id": 42,
        "firstname": "John",
        "lastname": "Doe",
        "email": "[email protected]",
        "displayPicture": "https://example.com/photos/john.jpg"
      },
      "book": {
        "isbn": "978-0-12345-678-9",
        "title": "The Great Adventure",
        "stock": 4,
        "coverImage": "https://example.com/covers/great-adventure.jpg",
        "author": {
          "id": 7,
          "name": "Jane Smith",
          "age": 45
        }
      },
      "loanDate": "2026-03-04T10:30:00Z",
      "returnDate": "2026-03-18T10:30:00Z",
      "returned": false
    }
  ],
  "pageable": {
    "pageNumber": 0,
    "pageSize": 10,
    "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
    },
    "offset": 0,
    "paged": true,
    "unpaged": false
  },
  "totalElements": 1,
  "totalPages": 1,
  "last": true,
  "first": true,
  "size": 10,
  "number": 0,
  "numberOfElements": 1,
  "empty": false
}

Build docs developers (and LLMs) love