Users

List all users

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>

The list can be filtered with parameters:

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

Shows all users with the term “@example.com” in their email address. It doesn’t matter if you use upper– or lowercase.
The following parameters can be used:

Show a specific user

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>Simon</first_name>
    <last_name>Stücher</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>

You can find a list of all rights at the description of roles.

Show a user image (avatar)

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

Returns the avatar for the user with the given ID. The image is cut square. The size in pixels can be specified by the size paramater.
If the parameter mode=FULL is specified, the uncropped original is returned.

Show the logged in user

GET /api/users/myself