endpoints.People.People

People properties

employment

 | @property
 | employment()

Returns:

Instance of endpoints.Employment.Employment

---

work

 | @property
 | work()

Returns:

Instance of endpoints.Work.Work

---

salaries

 | @property
 | salaries()

Returns:

Instance of endpoints.Salaries.Salaries

---

variable_payments

 | @property
 | variable_payments()

Returns:

Instance of endpoints.VariablePayments.VariablePayments

---

training

 | @property
 | training()

Returns:

Instance of endpoints.Training.Training

---

equities

 | @property
 | equities()

Returns:

Instance of endpoints.Equities.Equities

---

People methods

list

 | list(show_inactive=False)

Read company people

List of all active people of the company, data is filtered based on the access level of the logged-in user.

Only viewable categories are returned.

Arguments:

• show_inactive bool - should include inactive employees

References:

• https://apidocs.hibob.com/reference#get_people

---

search_employee

 | search_employee(identifier)

Read company people by id or email

Returns the employee by the specified id or email.

Arguments:

• identifier str - employee id or email

References:

• https://apidocs.hibob.com/reference#get_people-identifier

---

uninvite

 | uninvite(employee_id)

Revoke access to bob for employee

Arguments:

• employee_id str - employee id

References:

• https://apidocs.hibob.com/reference#post_employees-identifier-uninvite

---

invite

 | invite(employee_id, wizard_id)

Invite an employee with a welcome wizard Id.

Arguments:

• employee_id str - employee id
• wizard_id int -

References:

• https://apidocs.hibob.com/reference#post_employees-employeeid-invitations

---

start_date

 | start_date(employee_id, start_date, reason=None)

Set or update employee's start-date.

Arguments:

• employee_id str - employee id
• start_date date - the date this entry becomes effective
• reason str - additional info for the start date update

References:

• https://apidocs.hibob.com/reference#post_employees-employeeid-start-date

---

profiles

 | profiles(sort_by="firstName")

Read public profile section of an employee Returns the public section of all the active employees of the logged-in user company

Arguments:

• sort_by str - optional field name to sort by, defaults to firstName

References:

• https://apidocs.hibob.com/reference#get_profiles

---

read_avatar

 | read_avatar(email)

Read avatar for an employee

Arguments:

• email str - employee email

References:

• https://apidocs.hibob.com/reference#get_avatars

---

read_avatar_by_id

 | read_avatar_by_id(employee_id)

Read avatar for an employee id

Arguments:

• employee_id str - employee id

References:

• https://apidocs.hibob.com/reference#get_avatars-employeeid

---

upload_avatar_by_id

 | upload_avatar_by_id(employee_id, url)

Upload employee's avatar by providing a URL to the image to upload.

Arguments:

• employee_id str - employee id
• url str - the image to upload.

References:

• https://apidocs.hibob.com/reference#put_avatars-employeeid

---

my_avatar

 | my_avatar()

Read logged-in user avatar

References:

• https://apidocs.hibob.com/reference#get_my-avatar

---

update_email

 | update_email(employee_id, email)

Change an employee's email. Can't change self email, an invitation will be sent to the new address to verify the email if the employee is invited/active

Arguments:

• employee_id str - employee id
• email str - new employee's email

References:

• https://apidocs.hibob.com/reference#put_people-id-email

---

lifecycle

 | lifecycle(employee_id)

List employee's life-cycle status history Returns a list of life-cycle history entries for a given employee.

Arguments:

• employee_id str - employee id

References:

• https://apidocs.hibob.com/reference#get_people-id-lifecycle