Login Deutsch

Developers welcome! The mite.api is looking forward to your precious hacking. Have a look at the detailed documentation to kick-start your coding.

Users

Please note: This resource can be read by all users except time trackers. And, unlike other objects, users can only be read, not created or edited over the mite.api.

List all active users

List all active users, sorted by name:

GET /users.xml
GET /users.json

Parameters

name Filters the list by name. The given string will match partly and is treated as case-insensitive.
email Filter the list by email address. The given string will match partly and is treated as case-insensitive.
limit Limits the list to the given number of entries.
Default: indefinite
page Allows to access follow-up pages when combined with limit.
Default: 1

Response

Status: 200 OK
[
   {
      "user": {...}
   },
   {
      "user": {...}
   }
]
Status: 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<users type="array">
   <user>
      ...
   </user>
   <user>
      ...
   </user>
</users>

List all archived users

List all archived users, sorted by name:

GET /users/archived.xml
GET /users/archived.json

You can use the same parameters as for the active users.

Get a single user

Get a single user by her id:

GET /users/:id.xml
GET /users/:id.json

Response

Status: 200 OK
{
   "user": {
      "id": 2453,
      "name": "Susan Smart",
      "email": "smart@email.com",
      "note": "",
      "created_at": "2013-06-23T23:00:58+02:00",
      "updated_at": "2015-02-14T00:33:26+01:00",
      "archived": false,
      "language": "en",
      "role": "admin"
   }
}
Status: 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<user>
   <id type="integer">2453</id>
   <name>Susan Smart</name>
   <email>susan@email.com</email>
   <note></note>
   <archived type="boolean">false</archived>
   <role>admin</role>
   <language>en</language>
   <created-at type="datetime">2013-06-23T23:00:58+02:00</created-at>
   <updated-at type="datetime">2015-02-14T00:33:26+01:00</updated-at>
</user>