Every user who shares at least one collection with another user, has a collaborators record in the API response. The record contains a restricted subset of user-specific fields.
Field | Description |
_id | User ID of the collaborator |
Email of the collaborator Empty when authorized user have read-only access | |
email_MD5 | MD5 hash of collaborator email. Useful for using with Gravatar for example |
fullName | Full name of the collaborator |
role | Access level:
|
member
viewer
{"result": true,"emails": ["some@user.com","other@user.com"]}
//'emails' array is empty{"result": false,"errorMessage": "no emails"}​//'emails' array larger than 10{"result": false,"errorMessage": "you cant send more than 10 invites at once"}
//When user have more than 100 pending invitations:{"result": false,"errorMessage": "you have too many pending invitations, you will be banned if you continue send more"}​//User doesn't have enought permissions to invite more people{"result": false,"errorMessage": "you dont have permissions to invite more people"}
{"items": [{"_id": 373381,"email": "some@mail.com","email_MD5": "e12bda18ca265d3f3e30d247adea2549","fullName": "Jakie Future","registered": "2019-08-18T17:01:43.664Z","role": "viewer"}],"result": true}
{"result": true}
member
or viewer
{"result": true}
{"result": true}
{"result": true,"role": "member"}
//Incorrect token{"result": false,"error": "CollaboratorsIncorrectToken","errorMessage": "Incorrect or expired token"}​//Collection no more exists{"result": false,"error": "CollaboratorsNoCollection","errorMessage": "Shared collection not found or removed"}​{"result": false,"error": "CollaboratorsAlready","errorMessage": "You already owner of this collection"}