Skip to main content
GET
/
users
curl -X GET 'https://api.library.com/users?page=0&size=10&sort=lastname,asc' \
  -u username:password

{
  "200": {},
  "401": {},
  "content": [
    {
      "id": 123,
      "firstname": "<string>",
      "lastname": "<string>",
      "email": "<string>",
      "borrowedBooks": [
        {}
      ],
      "googleId": "<string>",
      "displayPicture": "<string>"
    }
  ],
  "pageable": {
    "pageNumber": 123,
    "pageSize": 123,
    "sort": {},
    "offset": 123,
    "paged": true,
    "unpaged": true
  },
  "totalPages": 123,
  "totalElements": 123,
  "last": true,
  "size": 123,
  "number": 123,
  "numberOfElements": 123,
  "first": true,
  "empty": true
}

​
Authentication

This endpoint requires HTTP Basic Authentication.

​
Query Parameters

​
page
integer
default:"0"
Page number (zero-indexed)
​
size
integer
default:"20"
Number of users per page
​
sort
string
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.Examples:
  • sort=lastname,asc
  • sort=email,desc
  • sort=id,asc&sort=lastname,desc

​
Response

The response follows Spring Data’s Page format:
​
content
array
Array of user objects
​
pageable
object
Pagination metadata
​
totalPages
integer
Total number of pages
​
totalElements
long
Total number of users across all pages
​
last
boolean
Whether this is the last page
​
size
integer
Page size
​
number
integer
Current page number (zero-indexed)
​
numberOfElements
integer
Number of elements in current page
​
first
boolean
Whether this is the first page
​
empty
boolean
Whether the page is empty

​
Status Codes

​
200
OK
Users successfully retrieved
​
401
Unauthorized
Missing or invalid authentication credentials
curl -X GET 'https://api.library.com/users?page=0&size=10&sort=lastname,asc' \
  -u username:password

Build docs developers (and LLMs) love

Get started for freeTalk to us