Skip to main content
POST
/
v1
/
companies
/
{company_id}
/
employees
Create a new employee
curl --request POST \
  --url https://api.vitablehealth.com/v1/companies/{company_id}/employees \
  --header 'Content-Type: application/json' \
  --header 'X-Partner-API-Key: <api-key>' \
  --data '
{
  "grant_benefit_eligibility_in": true,
  "email": "jsmith@example.com",
  "phone": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "address": {
    "address_line_1": "<string>",
    "city": "<string>",
    "zipcode": "<string>",
    "state": "<string>",
    "address_line_2": "<string>"
  },
  "employee_start_date": "2023-12-25",
  "middle_name": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_active_in": true,
    "created": "2023-11-07T05:31:56Z",
    "benefit_eligibility_start_date": "2023-11-07T05:31:56Z",
    "enrolled_in_benefits_in": true,
    "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "address": {
      "street_address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip_code": "<string>"
    },
    "address_str_format": "<string>",
    "first_name": "<string>",
    "full_name": "<string>",
    "date_of_birth": "2023-12-25",
    "email": "<string>",
    "age": 123,
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_name": "<string>",
    "hris_id": "<string>",
    "active_in": true,
    "employee_start_date": "2023-12-25",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "middle_name": "<string>",
    "last_name": "<string>",
    "phone_number": "<string>",
    "phone": "<string>",
    "profile_picture_url": "<string>",
    "preferred_language": "en",
    "public_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "individual_income_in_cents": 123,
    "household_income_in_cents": 123,
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "tag_color": "<string>",
        "description": "<string>"
      }
    ]
  }
}

Authorizations

​
X-Partner-API-Key
string
header
required

Partner API key for external integrations

Path Parameters

​
company_id
string<uuid>
required

Unique identifier for the company

Body

application/json
​
grant_benefit_eligibility_in
boolean
required

Whether to grant benefit eligibility to the employee

​
email
string<email>
required

Employee email address

Maximum string length: 256
​
phone
string
required

Employee phone number

Maximum string length: 256
​
first_name
string
required

Employee first name

Maximum string length: 64
​
last_name
string
required

Employee last name

Maximum string length: 64
​
date_of_birth
string<date>
required

Employee date of birth

​
address
object
required
​
employee_class
enum<string>
required

Employment classification

Available options:
Full Time,
Part Time,
Temporary,
Intern,
Seasonal,
Individual Contractor
​
employee_start_date
string<date>
required

Employee start date

​
employee_compensation_type
enum<string>
required

Compensation type

Available options:
Salary,
Hourly
​
middle_name
string | null

Employee middle name

Maximum string length: 200
​
suffix
enum<string> | null

Name suffix

Available options:
Sr,
Jr,
I,
II,
III,
IV,
V
​
sex
enum<string>

Employee biological sex

Available options:
Male,
Female,
Other,
Unknown
​
preferred_language
enum<string>

Employee preferred language

Available options:
en,
es,
zh,
ru,
sw,
th

Response

201 - application/json

Employee created successfully

​
data
object