Retrieve info about the logged in user

GET: /api/auth

Query parameters

Parameter Example Description
pretty ?pretty=true Pretty prints the result. Only useful for debugging.
select ?select=name,permissions Defines the fields that will be returned for the role.

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
  • username

Example response

GET: /api/auth
    "code": 200,
    "data": {
        "description": "The admin has all rights",
        "name": "admin",
        "title": "Admin"
    "status": "ok",
    "type": "model"