v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve employee details with payroll information

The purpose of this API is to retrieve employee details with payroll information.

get/v1/employees/{employee_id}

Path parameters

employee_idstring required

Employee id for whom the details are to be fetched.

Response

200

OR
OR
OR
OR
OR
OR

Example response

{
  "id": "387cd975-3587-4a6d-ae82-efeb7a602e37",
  "code": "APIUTT",
  "center_id": "30dc19eb-6dc8-4a47-8162-aa359a77ca4a",
  "created_by": "00000000-0000-0000-0000-000000000000",
  "personal_info": {
    "first_name": "Active",
    "last_name": "TherapistCatalogenabled",
    "notification_name": "Active Therapist",
    "email": "test@test.com",
    "mobile_phone": {
      "country_code": 225,
      "phone_code": 1,
      "number": "1212121212"
    },
    "home_phone": {
      "country_code": 225,
      "phone_code": 1
    },
    "work_phone": {
      "country_code": 225,
      "phone_code": 1
    },
    "gender": -1,
    "birth_date": "0001-01-01T00:00:00",
    "anniversary_date": "0001-01-01T00:00:00"
  },
  "address": {
    "country_id": 225,
    "state_id": 82
  },
  "login_info": {
    "username": "test@test.com"
  },
  "job_info": {
    "job_id": "38eb7e69-f76f-4a29-b7e5-6639b124b41f",
    "job_name": "MANAGER",
    "overtime_multiplier": 1,
    "start_date": "2020-02-12T00:00:00",
    "end_date": "0001-01-01T00:00:00",
    "tenure_start_date": "0001-01-01T00:00:00"
  },
  "preference_info": {
    "culture_id": 54,
    "receive_marketing_emails": true,
    "receive_marketing_messages": true,
    "receive_transactional_emails": true,
    "receive_transactional_messages": true,
    "allow_api_access": true,
    "additional_date_1": "0001-01-01T00:00:00",
    "additional_date_2": "0001-01-01T00:00:00",
    "send_confirmation_for_scheduled_appointments": true
  },
  "roles": {
    "security_profile_id": "00000000-0000-0000-0000-000000000000"
  },
  "catalog_info": {
    "show_in_catalog": true,
    "display_name": "catalog display name",
    "description": "this is a description"
  }
}