Users API

List users

Please note that the fields phone_fixed, phone_mobile and is_superadmin will only be included in the response if the user has administration rights.

GET /user
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • id
  • firstname
  • nickname
  • lastname
  • 0
  • 1

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 317
Content-Type: application/json
[
  {
    "id": 1,
    "nickname": "muster",
    "firstname": "Hans",
    "lastname": "Muster",
    "email": null,
    "color": "#CCFF00",
    "phone_fixed": null,
    "phone_mobile": null,
    "is_superadmin": true
  },
  {
    "id": 2,
    "nickname": "peter",
    "firstname": "Peter",
    "lastname": "Jobs",
    "email": null,
    "color": "#222222",
    "phone_fixed": null,
    "phone_mobile": null,
    "is_superadmin": true
  }
]

Search user

POST /user/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "nickname",
    "value": "muster"
  }
]
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • 0
  • firstname
  • id
  • lastname
  • nickname
  • 1
Name Required Type Description
id optional string
nickname optional string
firstname optional string
lastname optional string
color optional string

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 160
Content-Type: application/json
[
  {
    "id": 1,
    "nickname": "muster",
    "firstname": "Hans",
    "lastname": "Muster",
    "email": null,
    "color": "#CCFF00",
    "phone_fixed": null,
    "phone_mobile": null,
    "is_superadmin": true
  }
]

Show user

GET /user/1
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 2550
Content-Type: application/json
{
  "id": 1,
  "nickname": "muster",
  "firstname": "Hans",
  "lastname": "Muster",
  "email": null,
  "color": "#CCFF00",
  "phone_fixed": null,
  "phone_mobile": null,
  "is_superadmin": true,
  "profile_image": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAABRVJREFUWAmdV0tMXFUYvq+Z4WWwGhJjSq2S0IZNZaM7CYnGTZdCdIm8YSMkTZcMSZcuXBCepSxNYNGF0aTGBIgbaxd0YVWIxmqTYiBpS3gM87h3/L7D/a/n3pl7gZ7kzHl9//c/zn/OuWMaZyzZbNZBLRG+sLDwtuu67aZpvslxuVx+atv2Rn9//18c61iOk4qZtChrQjg7O9sGpV9i/qOamhrHsiwF8TzPOD4+LmHte/RvDA0N/SoywhHXnmqAEM3MzFyHl99AsZHL5eg1FZZJjD66plNbW0tDOL4+ODj4rcjGKed8ogEgsFC9+fn5VpBu0mN4WIBcCgpDvFjnuAgj08BwcHVgYGBLOEJgbXASQ20i0lXrIL9VV1cnytNR5ZTx59LIjQIiYVLG50rUEXZD0w4CcJrl6enpC/DqT3h/AZ55nNRgFV3IlYG1AH0OY1pGRkaeC1cFGBOx1k1OTipFUH4ROqmcYQ0pJzFrhNgkljKU5ZpwRXBqGGuAgOFMVIFaEq+gCN0KIxQGEagqK9xsTzUAmH0oKKINkYliMYRkWqFVxVQqta/NVe2GSHWEEC8tLb1aKBSYA68htEEOcF3H0yCOMS858Ozo6KhlbGzshXDpeOnHRoCEPEI9PT0v0H8EbyjjiaAo5FjvE0MslD6icnJE1oVCtSEv9BWxempq6nXHcTZQm7GnZ4oAks8C9h+07X19fc+ES+eXfmwEVlZW1Bq8eSudTjeXSqVAOYXplV6FEHMmlLuQu4TmMueFSzB6G2tAd3e3Cvfh4eFvxWLxb0TAgidqn4WAnrHKmC0x8NyGzBMMf+dcV1dXsHUc6yXWAIDKq6urzvj4eA6cD3jPo7i6QomAEPprLt8LlAd4D46QAw5xgom2SQYYu7u7ShAn4PbBwQFlHdRYMn/NQfYbkFmkQFtbWxI++R7ANrhzc3MpPCr3wHUb7wHDrb4JSF6llIhBJO7g2+A7ypKjCi6YSowAUdvb2+LBw0DqlA6uiw1CWltbRTZW4lQDJITw6j4uJBLFygBjE4M9/4lA2UL240oog+NATC4mEr6I7iPB3svn8/wYsXU8MG4mk3FgwM/YsvdFRsdU68d6o4PxmillSKwsiLnEfQ4gkbksF0QmAMV0zmQAZNU5xl3wC8439yHkvc/Ns18gxh/Hnn1/XTVnNUCBcbM58PZ/13Um9LlGTGQ6cZhoAB+S5eVlG4moSPHBmQcb86GCVOZ8DM+/Q1nYVAnWpCuspdKOjg6rs7PTRV/CqM4yEvBd5EGa7wIN0XjovYfwZ2DINcw/xflXR4YYGrG2tmavr697GqcSD0gIYuIAEFw0+BZ4A7faO7jar4D4Q0h8gjZNZWgDWV8JjwrfC0ZpBfUHbMcmxo9HR0f/JYYF/M7ExIQL7Ek2c5KhkhsLt9dVTPWgfozaAq8a8Bqia8j/AQpSfygX6ADm1Xn13w2DdwKixTv8D+DvwZGl3t7eTYwDnaYoX1xcfAXgr7D2eX19vYGMVhXEDL9HBSjMfrYh5ZhTRYygjI+x0Vr8QGHFy0rcHTj1BQzZp24VRvzruYy9/bGhoeEiHh2ScxuYoPyaUXuI/rkLjUChHHOG1YEOEzqe4Lr+YHh4+LFKQii/i1uMyhmuDCqLEvIJTmbO+VtFtgQVeehqxm16F3TtJv52fdrU1PT13t6egdCcU8XLwbHVRmNjI9+Kz3ixbO3s7NxEuHJImsR74eXUVZXyoJNfOFv/AcihymlkznQ3AAAAAElFTkSuQmCCMTc0OQ=="
}