Return all the sections information for a given employee Id.

get https://sandbox-api.kenjo.io/api/v1/employees/{employeeId}

This endpoint returns information about the account, personal, work, work schedule, address, financial and home sections for a given employee id. The employeeId param represents a Kenjo employee id. Additionally, custom fields configured for the respective sections will also be returned.

Responses

Response body

object

account

object

_id

string

The employee Kenjo _id.

string

The employee email in Kenjo. This is an unique identifier and required.

externalId

string

The employee external id for integration proposals.

isActive

boolean

The employee activation status.

language

string

The employee language. The available values are 'en' (english), 'es' (spanish) or 'de' (german).

personal

object

firstName

string

The name of the Kenjo employee. This field is required.

lastName

string

The surname of the Kenjo employee. This field is required.

displayName

string

The composition of firstName and lastName of the Kenjo employee.

gender

string

The gender of the Kenjo employee.

birthdate

string

The employee birth date. Format YYYY-MM-DDThh:00:00.000Z.

work

object

companyId

string

The company id of the Kenjo employee.

officeId

string

The office id of the Kenjo employee.

departmentId

string

The department id of the Kenjo employee.

startDate

string

The starting date of the Kenjo employee in format YYYY-MM-DDThh:mm:ss.

jobTitle

string

The job title of the employee.

workPhone

string

The work phone of the employee.

workMobile

string

The work mobile of the employee.

isAssistant

boolean

Allow to indicate if the employee has or not the assistant role.

probationPeriodEnd

string

The probation period of the employee. Format YYYY-MM-DDThh:mm:ss.000Z.

contractEnd

string

The contract end date of the employee. Format YYYY-MM-DDThh:mm:ss.000Z.

reportsToId

string

The Kenjo employee id of the user to whom the employee reports. The employee id to assign can be an active or inactive user. Trying to assign the own employee id or the id of someone who is already reporting will arise an error.

workSchedule

object

mondayWorkingDay

boolean

Allow to indicate if mondays are working days for the employee.

tuesdayWorkingDay

boolean

Allow to indicate if tuesdays are working days for the employee.

wednesdayWorkingDay

boolean

Allow to indicate if wednesdays are working days for the employee.

thursdayWorkingDay

boolean

Allow to indicate if thursdays are working days for the employee.

fridayWorkingDay

boolean

Allow to indicate if fridays are working days for the employee.

saturdayWorkingDay

boolean

Allow to indicate if saturdays are working days for the employee.

sundayWorkingDay

boolean

Allow to indicate if sundays are working days for the employee.

address

object

street

string

The name of the street.

postalCode

string

The postal code.

city

string

The city.

country

string

The country code in ISO 3166-1 alpha-2.

houseNumber

string

The house number.

additionalAddress

string

The additional address.

financial

object

accountHolderName

string

The accounts holder's name.

bankName

string

The bank name.

accountNumber

string

The account number.

iban

string

The IBAN.

swiftCode

string

The SWIFT code.

nationalId

string

The national id document.

passport

string

The passport number.

nationalInsuranceNumber

string

The national insurance number

taxCode

string

The tax number.

taxIdentificationNumber

string

The tax identification number.

home

object

maritalStatus

string

The marital status. Only is valid one of the following values "Divorced", "Domestic Partnership", "Married", "Separated", "Single", "Widowed".

spouseFirstName

string

The first name of the employee's spouse.

spouseLastName

string

The last name of the employee's spouse.

spouseBirthdate

string

The birth date of the employee's spouse. Format YYYY-MM-DDThh:mm:ss.000Z.

spouseGender

string

The employee's spouse gender. Only is valid one of the following values 'Male' (male), 'Female' (female) or 'Other' (other).

personalEmail

string

The employee personal email.

personalPhone

string

The employee personal phone.

personalMobile

string

The employee personal phone

401

UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox-api.kenjo.io/api/v1/employees/employeeId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400BAD REQUEST. This is a wrong request in the client side due to invalid body or params.