Skip to main content

User API

With the user API you can retrieve information about a specific user or a list of multiple users.

Retrieve user list [GET]

URI Parameter Required Requirements Description
range No int Defines the range of users which should be returned. Starts from 0. Default = 0.
limit No int Defines the number of users which should be returned. Default = 20. Upper limit = 20.
sort No string Defines the order of the results. Results are always ordered by id. Possible values: "asc" and "desc". Default = "asc".

Request:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/users?range=<range>&limit=<limit>&sort=<sort> HTTP/1.1

Response:

{
  "number_users": 12,
  "range": 1,
  "limit": 10,
  "sort": "desc",
  "number_ranges": 2,
  "users": [
    {
      "uid": 2,
      "mail": "user@example.com",
      "first_name": "Alex",
      "last_name": "User",
      "timezone": "Europe/Berlin",
      "language": "de",
      "created": 1627980505,
      "changed": 1627980505,
      "roles": [
          {
              "rid": 2,
              "name": "Editor"
          },
          {
              "rid": 4,
              "name": "Writer"
          }
      ]
    },
    {
      "uid": 15,
      "mail": "jon-doe@example.com",
      "first_name": "Jon",
      "last_name": "Doe",
      "timezone": "Europe/London",
      "language": "en",
      "created": 1627980505,
      "changed": 1627980505,
      "roles": [
          {
              "rid": 2,
              "name": "Editor"
          },
          {
              "rid": 3,
              "name": "Staff Member"
          }
      ]
    }
  ]
}

 

Retrieve information about a specific user [GET]

Request by user id:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/user/<user_id> HTTP/1.1

Request by user's email:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/user/<email> HTTP/1.1

Response:

{
  "uid": 15,
  "mail": "jon-doe@example.com",
  "first_name": "Jon",
  "last_name": "Doe",
  "timezone": "Europe/London",
  "language": "en",
  "created": 1627980505,
  "changed": 1627980505,
  "roles": [
      {
          "rid": 2,
          "name": "Editor"
      },
      {
          "rid": 3,
          "name": "Staff Member"
      }
  ]
}

Related articles