Skip to main content
POST
/
v1
/
employees
JavaScript
import BlueHive from '@bluehive/sdk';

const client = new BlueHive({
  apiKey: 'My API Key',
});

const employee = await client.employees.create({ email: 'dev@stainless.com', firstName: 'x', lastName: 'x' });

console.log(employee.employeeId);
{
  "success": true,
  "employeeId": "<string>",
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

API key for accessing BlueHive API endpoints. Format: "ApiKey <your-api-key>" or "Bearer <your-api-key>"

Body

application/json
firstName
string
required
Required string length: 1 - 100
lastName
string
required
Required string length: 1 - 100
email
string<email>
required
Maximum length: 254
dob
string
title
string
Maximum length: 200
activeAccount
enum<string>
Available options:
Active,
Inactive
blurb
string
Maximum length: 1000
address
object
phone
object[]
Maximum length: 5
employer_id
string
departments
string[]
Maximum length: 10
extendedFields
object[]
Maximum length: 20

Response

Employee created successfully

success
boolean
required
employeeId
string
required

ID of the created employee

message
string
required
I