Skip to content

/api/users

List users

Query parameters

Parameter Example Description
limit ?limit=5 Limits the number of returned users.
offset ?offset=10 Sets a manual offset. Use the page option together with limit for easier pagination.
page ?page=2 Starts the collection at the given page. Only works when the limit is set.
pretty ?pretty=true Pretty prints the result. Only useful for debugging.
select ?select=id,title Defines the fields that will be returned for each user.

User fields

The following fields are available in the user model and can be fetched with the select parameter:

  • avatar
  • blueprint
  • content
  • email
  • files
  • id
  • language
  • name
  • next
  • options
  • permissions
  • prev
  • role
  • roles
  • username