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

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

const employer = await client.employers.create({
  address: { city: 'city', state: 'state', street1: 'street1', zipCode: 'zipCode' },
  email: '[email protected]',
  name: 'name',
  phones: [{ number: 'number' }],
});

console.log(employer._id);
{
  "_id": "<string>",
  "name": "<string>",
  "address": {},
  "phones": [
    {}
  ],
  "email": "<string>",
  "website": "<string>",
  "onsiteClinic": true,
  "demo": true,
  "employeeConsent": true,
  "createdAt": "<string>",
  "createdBy": "<string>"
}

Authorizations

Authorization
string
header
required

API key for accessing BlueHive API endpoints. Format: "ApiKey " or "Bearer "

Body

application/json
name
string
required
Maximum length: 200
address
object
required
phones
object[]
required
email
string<email>
required
Maximum length: 200
billingAddress
object
website
string
onsiteClinic
boolean
demo
boolean
checkr
object
metadata
object

Response

Default Response

_id
string
required
name
string
required
address
object
required
phones
object[]
required
email
string
required
website
string
onsiteClinic
boolean
demo
boolean
createdAt
string
createdBy
string