Benutzer

Alle Benutzer auflisten

GET /api/users

<!--?xml version="1.0" encoding="UTF-8"?-->
<users type="array" page="1" per_page="100" total="2">
<user>
...
</user>
<user>
...
</user>
</users>

Über Parameter kann gefiltert werden

GET /api/users?email=@example.com

Listet alle Benutzer auf, die „@example.com“ in der E-Mail haben. Groß- und Kleinschreibung wird ignoriert.
Folgende Parameter stehen zur Verfügung:

Einzelnen Benutzer aufrufen

GET /api/users/{id}

<!--?xml version="1.0" encoding="UTF-8"?-->
<user>
<id type="integer">1</id>
<created type="datetime">2007-12-13T12:12:00+01:00</created>
<salutation>MR</salutation>
<first_name>Max</first_name>
<last_name>Muster</last_name>
<email>info@example.com</email>
<locale>de_DE</locale>
<timezone>Europe/Brussels</timezone>
<role_id>7</role_id>
<rights type="array">
<articles>DELETE</articles>
        <clients>DELETE</clients>
<offers>DELETE</offers>
<confirmations>DELETE</confirmations>
<invoices>DELETE</invoices>
<credit_notes>DELETE</credit_notes>
<delivery_notes>DELETE</delivery_notes>
<reminders>DELETE</reminders>
<settings_my_account>UPDATE</settings_my_account>
<settings_documents>UPDATE</settings_documents>
<settings_configuration>UPDATE</settings_configuration>
<settings_administration>UPDATE</settings_administration>
<settings_addons>UPDATE</settings_addons>
<settings_my_addons>UPDATE</settings_my_addons>
</rights>
</user>

Eine Übersicht über die mitgelieferten Rechte befindet sich in der Rollenbeschreibung.

Benutzerbild aufrufen

GET /api/users/{id}/avatar?size={size}

Liefert das Benutzerbild für den Benutzer mit der übergebenen ID. Das Bild wird quadratisch zugeschnitten. Die Größe in Pixel kann über den Paramater size angegeben werden.
Wird der Parameter mode=FULL angegeben, wird das nicht zugeschnittene Original zurückgeliefert.

Den angemeldeten Benutzer anzeigen

GET /api/users/myself