VODO ERP
  1. employees
VODO ERP
  • Accounts Module
    • Authentication
      • Register
        • Step 1
        • Step 2
        • Step 3
        • Step 4
      • Login
      • reset-password
      • forgot-password
      • logout
      • confirm_old_password
    • Permessions
      • user_permissions
      • user_permession_by_key_value
    • User
      • Profile
        • Show
        • Update
      • Show All Businessess of User
      • retrive-auth
    • Jobs
      • all_jobs
      • Jobs
      • one_job
      • new_job
      • delete_job
      • update_job
    • Business
      • Inventory Audit Process
        • Email
        • Verification
      • Email
        • Email To The Main Business
        • Email From Employee To Other Employees
      • Update
      • Update Expiration Date
      • Create Business
      • Show Business
      • Business With Ids
      • Show Business V2
      • business_details
    • Branches
      • Version 2
        • Show
      • reservation_branches
      • all branches by ids of branches
      • add_company_branch
      • All
      • Show
      • update_branch
    • Activities
      • All
    • Standard Catlog
      • Standard Products
        • All Standard Products
        • Category Of Product
        • one_product
      • categories
        • categories_list
    • Agents
      • Businesses Of Agent
    • Employees
      • All Employees
      • add_business_employee
      • business_employee_update
      • business_employee_show
      • business_employees
    • Payslips
      • get_payslip_status
      • get_payslip_status_by_role
      • payslip_items
    • get_user_from_token
    • get_cash_account
    • Notification Send Using Firebase
    • add_log
    • user_company
    • business_users
    • all_companies
    • Suppliers And Customers
    • New Request
    • add_store_keeper
    • currencies_list
    • get_one_customer
    • show_multi_jobs
    • one_service
    • get_cash_account
    • user_sub_modules
    • employee_password_update
  • Ecommerce Module
    • Catalog
      • Brands
        • All Brands
        • Add Brand
        • One Brand
        • Edit Brand
      • Category
        • All Categories
        • Add Category
        • One Category
        • Edit Category
      • Product
        • All Products
        • Add Product
        • Get Product Names By Ids
        • Get Product Name By Id
        • One Product
        • Edit Product
        • Delete Product Image
        • Delete Product Group
        • Display Product Type
        • Display Product Kind
        • Display Products By Ids
        • Get Product Type
        • Product Rating
        • Business Products
    • Product Prices
      • All Product Prices
      • All Number Product Prices
      • One Product Prices
      • One Product With Prices
      • Add Product Price
      • Add Product Main Price
      • Edit Product Main Price
      • Edit Product Price
      • Delete Product Build
      • Edit Product Main Price
      • Add Product Price Group
      • Product Price Groups
      • Edit Product Price Group
      • Check If Catalog Has Price
    • Units
      • Custom Units
        • Custom Units
        • Add Unit
        • Edit Unit
      • All Units
      • Default Units
      • One Unit
      • Product Child Units By Product Id
      • Child Units By Ids
      • Display Child Units Taken For The Product
      • Weight Height Unit Children
      • One Unit Child
    • Orders
      • Save Abandoned Order
      • Save Or Update to Abandoned Order
      • Change Abandoned Order Status
      • Change Payment Method And Status In Order
      • Change Item Qty Or Remove
      • Display Abandoned Order
      • Display Total Price Of The Order
      • Display User Order List
      • Display User Orders List V2
      • All Orders
      • All Orders Daily
      • Order Details
      • Unpaid Order List
      • Create New Order
      • Display One Order With Details If No sales_order_id
      • Update reservation_id In Order
      • Order Shipping Methods
      • Order Payment Methods
      • Order Status
      • Order Payment Status
      • Order Shipping Status
      • Post Or Update Order Fields
      • Add Items To Order
      • Edit Order Item Fields
      • Delete Order Item
      • Update Order And Item
      • Update Order Item Delivery Note
      • Update Payment Status
      • Create New Order V2
      • Update employee_id In Order
      • Check Order And Item
      • Update Order Status V2
      • Cancel Reservation And Employee In Order Item
      • Update Order Invoice Id
      • Get Order Status
    • Standard Products
      • All Standard Products
      • Import Standard Products
    • LFM
      • List Of Folders And Images
      • Create New Folder
      • Upload New Image
      • Move Image Or Folder
      • Rename Image Or Folder
      • Delete Image Or Folder
    • Reviews
      • All Reviews
      • Add Review
      • One Review
      • Edit Review
      • Delete Review
    • Barcodes
      • All Barcodes
      • Add Barcode
      • Edit Barcode
      • Display Product Details By Barcode
      • One Barcode Data
      • Delete Barcode
    • Attributes
      • All Attributes
      • Add Attributes
      • One Attribute
      • Edit Attribute
      • One Attribute Description
      • Change Attribute Status
      • Change Attribute Decription Status
      • Business Have Atrribute?
      • Display Child Units Taken For The Product
    • Distenations
      • Countries
        • All Countries
        • Add Country
        • One Country
        • Edit Country
      • States
        • All States
        • Add State
        • One State
        • Edit State
      • Cities
        • All Cities
        • Add City
        • One City
        • Edit City
      • Districts
        • All District
        • Add District
        • One District
        • Edit District
      • All Districts
      • All Countries
      • One District
      • All Cities
      • All Mosques
    • Inventory And Showroom
      • Inventories
        • All Inventories
        • Add New Inventory
        • Edit Inventory
        • All Inventory Item
        • Add New Inventory Item
        • Add New Inventory Trancfered Item
      • Inventories_v2
        • Inventories List
        • Add Inventory Item
        • Inventory Item List
        • Transfer Orders
        • Add Trancfered Order
        • Transfer Order And Items
        • Inventory Requests List
        • Inventory Transfers Transactions
        • One Transfers Transaction
        • Save Transfers Transaction
        • Available_Items
        • New Inventory Transfers
        • Transaction Items
        • Save Transaction Items
        • Inventory Item List_111
        • validate Inventory Or POS Session
      • Inventory Category
        • All Inventory Categories
        • Add Inventory Category
        • One Inventory Category
        • Edit Inventory Category
      • Showroom
        • Showroom List
        • Add New Showroom
        • Edit Showroom
        • All User Pos Sessions
        • Last POS Session
        • POSProductsList
        • POSProductsList V2
        • Add Pos Session Log
        • session_details
      • Showroom Category
        • All Showroom Categories
        • Add Showroom Category
        • One Showroom Category
        • Edit Showroom Category
    • Audit Sessions
      • Audit Session Items
        • All Audit Session Items
        • Add New Audit Item
        • Add New Audit Item
      • All Audit Sessions
      • Add New Audit Session
      • One Audit Session
      • Edit Audit Session
      • End Audit Session
    • Venues
      • Venues
        • All Venues
        • Active Venues
        • Add Venue
        • One Venue
        • Edit Venue
      • Venue Category
        • All Categories
        • Add Category
        • One Category
        • Edit Category
      • Tickets
        • All Tickets
        • Generate Ticket
        • One Ticket
    • Discounts
      • All Discounts
      • Add Discount
      • One Discount
      • Edit Discount
      • Apply Discount
    • Locations
      • All Locations
      • Add Location
      • One Location
      • Edit Location
    • Favourites
      • All Favourites
      • Add Or Remove Catalog From Favorites Copy
    • Galleries
      • All Galleries
      • Add Galleries
      • One Gallery
      • Edit Galleries
    • Banner
      • All Banners
      • Add Banner
      • One Banner
      • Edit Banner
    • News
      • All News
      • Add News
      • One News
      • Edit News
    • Pages
      • All Pages
      • Add Pages
      • One Page
      • Edit Pages
    • Catalog Comments
      • All Catalog Comments
      • Add Catalog Comment
      • One Catalog Comment
      • Edit Catalog Comment
      • Delete Catalog Comment
    • Artist
      • All Artist
      • Add Artist
      • One Artist
      • Edit Artist
  • HR Module
    • employees
      • employees
        POST
      • employee
        GET
      • employee By User Id
        GET
      • select employee
        GET
      • employees_have_same_skill
        GET
      • array_of_employees_have_same_skill
        GET
      • employees/reduce
        GET
      • trashed employees
        GET
      • POST/ add employee
        POST
      • employee_bulk
        POST
      • update_employee
        PUT
      • delete employee
        DELETE
      • get user profile
        GET
      • get Reservation Count
        GET
      • get Trainer Employees
        GET
      • update Occupation Id
        POST
      • update Main Profile
        POST
      • employees Have Service Skills
        GET
      • employee Fingerprint Locations
        GET
      • employees bulk Activation
        POST
      • Add Accounts User
        POST
    • skills
      • GET/ skils
      • GET/ skill
      • POST/ add skill
      • PUT/ skill
      • DELETE/ skill
    • administration
      • GET/ administration
      • administration - trashed
      • POST/ administration
      • PUT/ administration
      • DELETE/ administration
      • restor Administration
    • sections
      • GET/ sections
      • GET/ section by id
      • sections_by_administration
      • POST/ add section
      • PUT/ section
      • delete - section
    • employee - vacation
      • GET/ vacations
      • POST/ vacation
      • PUT/ vacation
      • DELETE/ vacation
    • residence-status
      • residences
      • residences
      • residences Copy
      • residences
    • contracts
      • all contracts
      • show contract
      • business - all contracts
      • Contract Media
      • create contract
      • edit contract
    • departments
      • GET/ department
      • POST/ add department
      • PUT/ department
      • DELETE/ department
    • payslips
      • payslips
      • get payslip
      • employee_payslips
      • payslips - trashed
      • add payslips
      • restore - payslip
      • update
      • delete - payslip item
      • delete - payslip
      • get Scheduled Approved Payslips
      • edit Payslip Status
      • bulk Update Payslips Status
      • check in_review payslip status
    • settings
      • update settings
      • get Business Settings
    • setting - payrole
      • all payroles
      • settings - payroles - infractions
      • active_infractions
      • update setting - payrole
      • delete Payrol
      • settings - payroles - repetition
    • settings - schedule tiems
      • scheduletiems
      • insert - update schedule times
      • schedule times
    • settings - vacations
      • vacations
      • vacation
      • vacation
    • employee - measure
      • measures
      • measures
      • update measures
      • update Measure Status
      • delete measures
    • employee - measure - status
      • measures - status
      • add - measures - status
      • update measures - status
      • delete measures - status
    • penalties
      • GET/ penalties
      • POST/ penalte
      • DELETE/ penalte
    • loan
      • all loans
      • one Loan
      • add - loan
      • update Loan
      • loan
    • employees v2
      • employees
      • employee
      • employees/reduce
      • add employee
      • update
      • delete employee
    • payslip v2
      • payslips
      • payslip
      • update
    • will delete
      • skills type
        • GET/ skils typs
        • POST/ add skill type
        • PUT/ skill type
        • DELETE/ skill
      • Currencies
        • GET/ currencies
        • GET/ currencie
        • POST/ add currencies
        • POST/ edit currencie
        • DELETE/ delete currencie
      • nationalities
        • GET/ nationalities
        • GET/ nationalitie
        • POST/ add nationalitie
        • POST/ edit nationalitie
        • DELETE/ delete nationalitie
      • occupations
        • GET/ occupations
        • GET/ occupation
        • POST/ occupation
        • PUT/ occupation
        • DELETE/ occupation
      • companies
        • GET/ companies
        • GET/ company
        • POST/ company
        • PUT/ company
        • DELETE/ company
      • employers
        • GET/ employers
        • GET/ employer
        • POST/ employer
        • PUT/ employer
        • DELETE/ employer
      • activations
        • GET/ activations
        • get activation
        • POST/ add activations
        • PUT/ edit activations
        • DELETE/ delete activations
    • settings-infractions
      • all infractions
      • infraction repetitions
      • update setting infraction
      • active_infractions
    • Agreements
      • all agreements
      • get one agreement
      • add agreement
      • update agreement
      • update agreement status
      • available Employees To Work
    • Settings agreement status
      • all agreements status
      • add agreement status
      • update agreement status
      • delete agreement status
    • Settings agreement invoices status
      • all agreements status
      • add agreement status
      • update agreement status
      • delete agreement status
    • Entry and Exit
      • get all
      • employee Day Activity
      • employee Attendance Summary
      • export excel
      • employee finger print
    • Logs
      • get all
      • get one
    • Requests
      • All Requests
      • get Employee Requests
      • add New Request
      • update Request Status
    • Audits
      • All Audits
    • GET/business_id
      GET
    • test
      GET
  • Calendar Module
    • Calendars
      • new_calendar
      • add_new_calendars
      • update_calendars
      • show Calendars With Working hours
      • time_zone_list
      • calendars_list
      • edit_calendar
      • delete_calendar
      • show_calendar
      • all_business_calendars_list
      • all_calendars_list[my-other-standard]
    • Calendar Working Hours
      • show_working_hours
      • add_work_hours
      • edit_work_hours
      • all_week_days
      • calendar_working_hours
    • Calendar Vacations
      • calendar_vacation
      • add_Vacation
      • edit_vacation
      • show_vacation
      • get_week_vacation_days
    • Calendar Break
      • new_break
      • all_breaks
      • one_break
      • update_break
      • delete_break
    • Calendar Tours
      • add New Tour
      • update Tour
      • get Customer Categories Tours
      • get Tour Customer Categories Ids
      • get Tour Categories Ids
      • get Audience Statistics
      • get Category Type Statistics
      • get Attendance Statistics
      • get Array Of Tours Id
      • get Tours Reservations
      • get Customer Category Venue Id
    • Attendances
      • get Attendances
      • get One Attendance
      • get Customer Attendances
      • get Customer Bookings
      • get Customer Booked Bookings
      • get Tout Category Customer Ids
      • add New Attendance
      • update Attendance
      • update Multi Attendances
      • change Customer Tour Status
      • auto Mark Not Attended Tours
      • decrypt QR
      • show QR Code
      • get Attendances Dates and times
      • get Attendances Times By Dates
      • get Categories Attendance By Tour Copy
      • delete Attendance Item
    • Events
      • add_event
      • all_calendar_events
      • edit_event
      • show_event
      • destroy_event
      • get_employee_times
      • get_available_employee_times
      • get_all_user_calendars_events
      • drag Drop Update Event
      • get Employees Events
      • get Employee Slots
      • get Employee Today And Tomorrow Slots
      • get Slot Details
    • Services
      • services_list
      • service_details
      • service_employees
      • add_service
    • Default Calendar
      • add_default_calendar
      • get_default_calendar
    • Reservtions
      • reservation_status_list
      • chang_reservation_status
      • update Reservations Status
      • employee_reservations_count
      • Employees_reservation_num
      • get_reservations_daily
      • get_reservations_monthly_yearly
      • get One Reservation
      • get Today-Tomorrow Reservations
      • add Delivery Note Id
      • update service ecomm_id
      • get Reservations By Order Id
    • BI
      • get Tables
      • get Table Columns
    • Customers
    • company_branches
    • business_employees
    • get available_specialists
    • get pos_available_specialists
  • Accounting Module
    • payslips
      • approve_payslip
    • business_v4
      • update_business
    • Production Orders
      • Average cost
      • store-production-acc-total
    • Divisions
      • divisions_list
      • get_division
    • Gateways
      • Telr
        • checkout
    • Branches
      • create_branch
      • nearest_customers
    • Countries
    • Add invoice
      • income_accounts_list
      • add_invoice
      • get_customers_list
    • Employees_invoice_paymanet
      • Apis_v4
        • customers
          • Get_Customers
          • Get_customer_invoices_list
          • Get_customer_wallet_list
          • Get_customer_receivable_list
          • add_one_customer
          • update_one_customer
          • show_one_customer
        • customers_categories
          • Get_customers_categories
          • add_one_customers_category
          • show_one_customers_category
          • update_one_customers_category
        • customers_branches
          • get_customers_branches
          • get__one_customer_branch
          • add_one_customer_branch
          • update_one_customer_branch
      • add_new_payment
      • bank_cash_list
      • AllCurrencies
    • Payslip items
      • ItemsList
      • add_item
      • edit_item
      • delete_item
      • get by id
      • add_invoice Copy
    • Authentication
      • Redirect Auth
      • Show User By Token
    • Accounts Totals
      • All Accounts Totals
    • Journal Totals
      • All Journals
      • daily_year_month
    • Account logs
      • Create Log
      • Create Log Copy
    • Modules
      • All Modules
      • Show Module
      • Sub Sub Modules
    • Taxes
      • Show Tax
      • All Taxes
      • get_one_tax
    • Inventory items
      • all inventory items
    • Cash And Bank Accounts
      • All Cash And Banks Accounts
      • Add Account
      • Get Cash Account
    • Customers And Suppliers
      • Authentication
        • v4
          • update_one_customer
          • get_customer_from_token
          • reset_password
          • add_one_customer
        • v3
          • add_one_customer
          • customer_login
          • reset_password
          • forgot_password
          • send_otp
          • confirm_otp
          • send_email_otp
          • confirm_email_otp
          • reset_password_by_mail
          • forgot_password_by_mail
          • phone_exist
          • add_pos_customer
      • Home
        • GetCustomer/Supplier Wallet total
        • Get_Customers
        • Get_customer_invoices_list
        • Get_customer_wallet_list
        • Get_customer_receivable_list
        • show_one_customer
        • show_one_customer_by_id
        • show_multi_customers_by_id
        • get_customer_by_phone
      • Charts
        • Charts Suppliers And Customers
        • Charts Count Suppliers And Customers Copy
      • Categories
        • Get_customers_categories
        • add_one_customers_category
        • show_one_customers_category
        • update_one_customers_category
      • Branches
        • get_customers_branches
        • get__one_customer_branch
        • add_one_customer_branch
        • update_one_customer_branch
    • Payments Recipts
      • All Payments Receipts
      • Create Payment Receipt
      • Create Payment Receipt Ecommerce
      • New Payment Checkout
      • Create Advance Receipt
    • Accounts
      • All Accounts
    • Journal entries
      • Create Journal
      • All Journal Entries
    • Inventory Locations
      • All Inventory Locations
      • Inventory Location from driver
    • Good Receipts
      • Create Good Receipts
    • Delivery Notes
      • All Delivery Notes
      • Create delivery note
    • Purchase invoices
      • All Purchase Invoices
    • Sales invoices
      • v4
        • Sales invoices
          • All Sales Invoices
          • AddOneInvoice
          • ShowOneInvoice
      • Add POS Invoice
      • All Sales Invoices
      • Customer Invoices
      • Create Invoice
      • Create Invoice For VODO APP
    • Special Accounts
      • Special Accounts
    • Capital Accounts
      • All Capital Accounts
    • Fixed Assets
      • All Fixed Assets
    • Businesses
      • Show business
      • All Business
      • Show business secure
    • Accounting_APIs_v4
      • Sales invoices
        • All Sales Invoices
        • AddOneInvoice
        • ShowOneInvoice
      • SalesQuotes
        • GetSalesQuotes
        • AddOneSalesQuote
        • ShowOneSalesQuote
        • UpdateOneSalesQuote
        • DeleteOneSalesQuote
      • SalesQuotes Copy
        • GetSalesQuotes
        • AddOneSalesQuote
        • ShowOneSalesQuote
        • UpdateOneSalesQuote
        • DeleteOneSalesQuote
      • SalesOrders
        • Get_Sales_orders
        • Add_one_Sales_order
        • Show_one_Sales_order
        • Update_one_Sales_order
        • Deleate_one_Sales_order
        • add_update_order_due
      • CustomersAPis
        • customers
          • customers Copy
            • Get_Customers
            • Get_customer_invoices_list
            • Get_customer_wallet_list
            • Get_customer_receivable_list
            • add_one_customer
            • update_one_customer
            • show_one_customer
            • show_one_customer_by_id
            • update_customer_phone
            • show_multi_customers_by_id
            • get_customer_by_phone
          • Get_Customers
          • Get_customer_invoices_list
          • Get_customer_wallet_list
          • Get_customer_receivable_list
          • add_one_customer
          • update_one_customer
          • show_one_customer
          • show_one_customer_by_id
          • update_customer_phone
          • show_multi_customers_by_id
          • get_customer_by_phone
        • customers_branches
          • get_customers_branches
          • get__one_customer_branch
          • add_one_customer_branch
          • update_one_customer_branch
      • Currencies
        • GetAllCurrencies
        • Get_currency_with_exchage
        • Get_base_currency
      • BankCashAccounts
        • get_acutal_balance
      • Refund
        • refund_invoice
        • All Refund Sales Invoices
        • Refund Sales Invoices Items
    • v5
      • Customers Or Suppliers
        • Categories
          • Create Category
          • All Categories
          • Update Category
          • Delete Category
        • Branches
          • All Branches
          • Create Branch
          • Update Branch
          • Show Branch
          • Delete Branch
        • Create Customer Or Supplier
        • Get All Customers Or Suppliers
        • Update Customer Or Supplier
        • Show Customer Or Supplier
        • Show Accounts Receivable
        • Show Wallet Transactions
      • Bank And Cash Accounts
        • Get All Cash And Bank Accounts
        • Create Cash Or Bank Account
        • Update Cash Or Bank Account
        • Show Cash Or Bank Account
      • Inter Account Transfers
        • Update Transfer
        • Get All Inter Account Transfers
        • Create Transfer
        • Show Transfer
      • Payment And Receipt
        • Update Payment Or Receipt
        • All Payment Or Receipt
        • Show Payment Or Receipt
        • Delete Payment Or Receipt
        • Create Payment Or Receipt
      • Sales Invoices
        • Update Invoice
        • All Sales Invoices
        • Show invoice
        • Create Invoice
      • Chart Accounts
        • Get All Chart Accounts
      • Currency
        • Add Currency To The Business
        • Get All Currencies Symbols
        • Get All Foreign Currencies
    • Send Mails
    • get_customer_cat_by_id
    • check_business_tax_required
  • CRM Module
    • Support Tickets
      • All Support Tickets
      • Add Support Ticket
      • One Ticket
      • Edit Support Ticket
      • Reply To Support Ticket
      • Download Ticket Attachment
    • Whatsapp Integration
      • Send Message
      • Send Template Message
  • Managment Module
    • WorkSpaces
      • Boards
        • get Boards
        • get Board
        • add Board
        • update Board
        • Archive Board
        • Delete Board
      • Attachments
        • Get Attachments
        • Get Attachment
        • add Attachment
        • Delete Attachment
      • Projects
        • Get Projects
        • Get Project
        • Add Project
        • Update Project
        • Delete Project
      • Tasks
        • Get Tasks
        • Get Task
        • Add New Task
        • Update Task
        • Delete Task
        • Force Delete Task
        • Assign Users To Task
      • get WorkSpaces
      • get Workspace
      • add Workspace
      • update Workspace
      • delete Workspace
      • Add Team To Workspace
  1. employees

POST/ add employee

Testing Env
https://testhr.vodoglobal.com
Testing Env
https://testhr.vodoglobal.com
POST
/api/v1/employees
Last modified:2025-03-26 12:40:51

Request#

The API endpoint allows you to create a new employee with the provided details. The request should be sent as an HTTP POST to the specified URL. The request body should be in raw JSON format and include various details such as name, user name, user type, active status, source, social situation, contact details, nationality, occupation, employment details, passport information, bank details, visa details, skills, education, and work experience.

Response#

The response to the request is a JSON object with the following schema:
{
    "type": "object",
    "properties": {
        "status": {"type": "boolean"},
        "message": {"type": "string"},
        "response": {
            "type": "object",
            "properties": {
                "business_id": {"type": "integer"},
                "type": {"type": "string"},
                "active": {"type": "integer"},
                "source": {"type": "string"},
                "social_situation": {"type": "string"},
                "calendar_id": {"type": "integer"},
                "phone": {"type": "string"},
                "email": {"type": "string"},
                "national_id": {"type": "string"},
                "nationality_id": {"type": "integer"},
                "occupation_id": {"type": "integer"},
                "section_id": {"type": "integer"},
                "company_id": {"type": "integer"},
                "job_number": {"type": "string"},
                "border_number": {"type": "string"},
                "administration_id": {"type": "integer"},
                "administration_admin": {"type": "integer"},
                "trainer": {"type": "integer"},
                "department_id": {"type": "integer"},
                "emergency_name": {"type": "string"},
                "emergency_phone": {"type": "string"},
                "color": {"type": "string"},
                "bio": {"type": ["null", "object"]},
                "agent_ids": {"type": ["null", "array"]},
                "employer": {"type": "string"},
                "employer_company_id": {"type": "integer"},
                "employer_branch_id": {"type": "integer"},
                "employer_department_id": {"type": "integer"},
                "employer_section_id": {"type": "integer"},
                "updated_at": {"type": "string"},
                "created_at": {"type": "string"},
                "id": {"type": "integer"},
                "user_id": {"type": "integer"},
                "name": {"type": "string"},
                "user_name": {"type": "string"},
                "primary_email": {"type": "string"},
                "profile_url": {"type": "string"}
            }
        }
    }
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://testhr.vodoglobal.com/api/v1/employees' \
--header 'secure-business-key: 4765066450c0bd66325.48403130' \
--header 'user-token: ' \
--header 'uuid: 630ca2f4885f8' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "api doc",
    "user_name": "api_doc",
    "user_type": "employee",
    "active": 1,
    "source": "internal",
    "social_situation": "single",
    "calendar_id": 1,
    "primary_email": "fagoxen3600@nastyx.com",
    "phone": ["1234567890", "0987654321"],
    "email": ["xohoco9231@nastyx.com"],
    "national_id": "321547892254",
    "nationality_id": 1,
    "occupation_id": 66,
    "section_id": 3,
    "company_id": 4,
    "job_number": "EMP123",
    "border_number": "B123456",
    "administration_id": 5,
    "administration_admin": 34,
    "trainer": 34,
    "department_id": 6,
    "emergency_name": "Jane Doe",
    "emergency_phone": "1234567890",
    "employer": "company",
    "employer_company_id": 7,
    "employer_branch_id": 3,
    "employer_department_id": 8,
    "employer_section_id": 9,
    "passport_number": "P123456",
    "release_date": "2024-01-01",
    "expiry_date": "2034-01-01",
    "side_version": "Version 1",
    "function": "Function Name",
    "address": "123 Main St",
    "country_code": "US",
    "date_of_birth": "1999-01-01",
    "insurance_start_date": "2024-01-01",
    "insurance_end_date": "2025-01-01",
    "place_of_birth": "City",
    "country_of_birth": "Country",
    "city_id": 10,
    "country_id": 11,
    "id_issuance_date": "2020-01-01",
    "id_expiration_date": "2030-01-01",
    "bank_name": "Bank Name",
    "account_name": "John Doe",
    "account_number": "1234567890",
    "iban_no": "IBAN123456",
    "currency_id": 1,
    "bank_address": "Bank Address",
    "bank_country": "Country",
    "source_company_id": 12,
    "source_administration_id": 13,
    "source_section_id": 14,
    "building_no": "Building 1",
    "residence": 1,
    "branch_start_date": "2024-01-01",
    "entering": "2024-01-01",
    "expire_h": "2024-12-31",
    "expire_m": "2024-12-31",
    "work_permit_number": "WP123456",
    "visa_number": "V123456",
    "date_of_issuance_of_the_visa": "2024-01-01",
    "visa_expiry_date": "2025-01-01",
    "branch_id" : 2,
    "color" : "#259874",
    "skills": [
        {
            "skill_id": 1,
            "level": 90
        },
        {
            "skill_id": 2,
            "level": 70
        }
    ],
    "schools": [
        {
            "school_name": "University A",
            "start_date": "2018-09-01",
            "end_date": "2022-06-30"
        }
    ],
    "experiences": [
        {
            "company_name": "Company X",
            "occupation_id": 3,
            "start_date": "2022-07-01",
            "end_date": "2023-12-31"
        }
    ],
    "services_skill": [1, 2]
}'
Response Response Example
{
    "status": true,
    "message": "success",
    "response": {
        "business_id": 259,
        "type": "employee",
        "active": 1,
        "source": "internal",
        "social_situation": "single",
        "calendar_id": 1,
        "phone": "[\"1234567890\",\"0987654321\"]",
        "email": "[\"xohoco9231@nastyx.com\"]",
        "national_id": "321547892254",
        "nationality_id": 1,
        "occupation_id": 66,
        "section_id": 3,
        "company_id": 4,
        "job_number": "EMP123",
        "border_number": "B123456",
        "administration_id": 5,
        "administration_admin": 34,
        "trainer": 34,
        "department_id": 6,
        "emergency_name": "Jane Doe",
        "emergency_phone": "1234567890",
        "color": "#259874",
        "bio": null,
        "agent_ids": null,
        "employer": "company",
        "employer_company_id": 7,
        "employer_branch_id": 3,
        "employer_department_id": 8,
        "employer_section_id": 9,
        "updated_at": "2025-03-20T09:31:02.000000Z",
        "created_at": "2025-03-20T09:30:58.000000Z",
        "id": 3419,
        "user_id": 1006,
        "name": "api doc",
        "user_name": "api_doc",
        "primary_email": "fagoxen3600@nastyx.com",
        "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png"
    }
}

Request

Header Params
secure-business-key
string 
required
Example:
{{secure_business_key}}
user-token
string 
required
Example:
{{user_token}}
uuid
string 
required
Example:
{{uuid}}
Body Params application/json
name
string 
required
user_name
string 
required
user_type
string 
required
active
integer 
required
source
string 
required
social_situation
string 
required
calendar_id
integer 
required
primary_email
string 
required
phone
array[string]
required
email
array[string]
required
national_id
string 
required
nationality_id
integer 
required
occupation_id
integer 
required
section_id
integer 
required
company_id
integer 
required
job_number
string 
required
border_number
string 
required
administration_id
integer 
required
administration_admin
integer 
required
trainer
integer 
required
department_id
integer 
required
emergency_name
string 
required
emergency_phone
string 
required
employer
string 
required
employer_company_id
integer 
required
employer_branch_id
integer 
required
employer_department_id
integer 
required
employer_section_id
integer 
required
passport_number
string 
required
release_date
string 
required
expiry_date
string 
required
side_version
string 
required
function
string 
required
address
string 
required
country_code
string 
required
date_of_birth
string 
required
insurance_start_date
string 
required
insurance_end_date
string 
required
place_of_birth
string 
required
country_of_birth
string 
required
city_id
integer 
required
country_id
integer 
required
id_issuance_date
string 
required
id_expiration_date
string 
required
bank_name
string 
required
account_name
string 
required
account_number
string 
required
iban_no
string 
required
currency_id
integer 
required
bank_address
string 
required
bank_country
string 
required
source_company_id
integer 
required
source_administration_id
integer 
required
source_section_id
integer 
required
building_no
string 
required
residence
integer 
required
branch_start_date
string 
required
entering
string 
required
expire_h
string 
required
expire_m
string 
required
work_permit_number
string 
required
visa_number
string 
required
date_of_issuance_of_the_visa
string 
required
visa_expiry_date
string 
required
branch_id
integer 
required
color
string 
required
skills
array [object {2}] 
required
skill_id
integer 
required
level
integer 
required
schools
array [object {3}] 
required
school_name
string 
optional
start_date
string 
optional
end_date
string 
optional
experiences
array [object {4}] 
required
company_name
string 
optional
occupation_id
integer 
optional
start_date
string 
optional
end_date
string 
optional
services_skill
array[integer]
required
Examples

Responses

🟢200add Employee
application/json
Body
status
boolean 
required
message
string 
required
response
object 
required
business_id
integer 
required
type
string 
required
active
integer 
required
source
string 
required
social_situation
string 
required
calendar_id
integer 
required
phone
string 
required
email
string 
required
national_id
string 
required
nationality_id
integer 
required
occupation_id
integer 
required
section_id
integer 
required
company_id
integer 
required
job_number
string 
required
border_number
string 
required
administration_id
integer 
required
administration_admin
integer 
required
trainer
integer 
required
department_id
integer 
required
emergency_name
string 
required
emergency_phone
string 
required
color
string 
required
bio
null 
required
agent_ids
null 
required
employer
string 
required
employer_company_id
integer 
required
employer_branch_id
integer 
required
employer_department_id
integer 
required
employer_section_id
integer 
required
updated_at
string 
required
created_at
string 
required
id
integer 
required
user_id
integer 
required
name
string 
required
user_name
string 
required
primary_email
string 
required
profile_url
string 
required
Previous
trashed employees
Next
employee_bulk
Built with