Skip to content

Kirby 4.3.0

GET /api/users

List users

Query parameters

Parameter Example Description
limit limit=5|null Limits the number of returned users.
offset offset=10|null Sets a manual offset. Use the page option together with limit for easier pagination.
page page=2|null Starts the collection at the given page. Only works when the limit is set.
pretty pretty=true|null Pretty prints the result. Only useful for debugging.
select select=id,title|null 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
  • panelImage
  • permissions
  • prev
  • role
  • roles
  • username
  • uuid