GET
The GET method returns a user object. Users can be identified by id:
GET https://projecten.viadesk.com/api/user.json?id=618… GET https://projecten.viadesk.com/api/user.json?id=mar… &fullprofile=true // optional, default is false, returns all properties visible on the user profile
response body: { "id": "6180-75736572", "email": "marc@viadesk.nl", "name": "Marc Leidner", "lastname": "Leidner", "firstname": "Marc", "company": "Viadesk", "gender": "male", "thumbnailUrl": "https://projecten.viadesk.com/thumbnail/393836-757… // last digits indicate image size "created": "2007-06-20T16:51:43CEST" }
{ "id": "6180-75736572", "email": "marc@viadesk.nl", "name": "Marc Leidner", "lastname": "Leidner", "firstname": "Marc", "company": "Viadesk", "gender": "male", "thumbnailUrl": "https://projecten.viadesk.com/thumbnail/393836-757… // last digits indicate image size "created": "2007-06-20T16:51:43CEST" }
POST
The POST method allows to create or update a User and as well set permissions. Setting permissions on an Office can be done directly or via adding people to member lists.
This method can only be called as a Webmaster.
POST https://projecten.viadesk.com/api/user.json form field “email” // required form field “lastname” // required form field “fid” // foreign id, optional (see 1) form field “invite” // boolean, default is true, optional (see 2) form field “memberlist” // pointer, optional (see 3) form field “officepermission” // string, optional (see 4) other... // optional (see 5)
PUT
Use PUT to upload a user's profile photo.
PUT https://projecten.viadesk.com/api/user.json?id=mar…
[file in request body]
DELETE
The DELETE method allows to permanently remove users or to deactivate them. The id parameter is required. The deactivateonly parameter is optional (default is true)
DELETE marc@viadesk.nl&deactivateonly=true">https://projecten.viadesk.com/api/user.json?id=marc@viadesk.nl&deactivateonly=true