Company::employees
Current company's employees
Resource description
This resource allow you to manage your company’s employees.
As company admin, you can, in addition to listing your employees:
- Add employees (through invitation or manually created Winddle users)
- Transfer all the objects owned by an employee to another employee
- Activate/deactivate employees’ accounts (to release unused licences)
- Promote employees to admin/product_owner (or revoke those authorisations)
GET /api/v1/company/employees
Return a list of all employees in the current company
POST /api/v1/company/employees
Create a new user account (use a licence)
A password will be automatically generated and sent by e-mail.
Params
Param name | Description |
---|---|
first_name optional |
First name of the employee Must be a String |
last_name optional |
Last name of the employee Must be a String |
email optional |
Email of the employee Must be a String |
POST /api/v1/company/employees/invite
Invite a new employee to your company
The employee will receive an e-mail with a link to register in Winddle.
He/she’ll be able to enter their name and choose their own password, then, they’ll automatically join your company.
Params
Param name | Description |
---|---|
email optional |
Email of the employee to invite Must be a String |
PATCH /api/v1/company/employees/:id/roles
Promote and unpromote user as company admin, account admin and product owner
Params
Param name | Description |
---|---|
company_admin optional |
Promote employee as company admin Boolean (true/false) |
account_admin optional |
Promote employee as account admin Boolean (true/false) |
product_owner optional |
Promote employee as product owner Boolean (true/false) |
PATCH /api/v1/company/employees/:id/transfer_to
Transfer ownership of all the objects of this employee to a new employee
Params
Param name | Description |
---|---|
new_owner required |
Winddle ID or email of the new owner Must be a String or an Integer |
PATCH /api/v1/company/employees/:id/activate
Activate the employee's account (use a licence)
PATCH /api/v1/company/employees/:id/deactivate
Deactivate the employee's account (release a licence)