Bulk Import Employees

Import up to 500 employee records in a single request.

POST
/api/v1/employees/bulk-import

Description

Creates employee location records from an array. Validates all rows before inserting; if any row fails validation, no records are processed. Skips emails that already exist for the company.

Request

Headers

HeaderValueRequired
AuthorizationBearer <access_token>Yes
Content-Typeapplication/jsonYes

Body Parameters

ParameterTypeRequiredDescription
employeesarrayYesArray of employee objects (max 500). Supports camelCase or PascalCase field aliases.

Each object in employees[]

Same fields as Create Employee. Aliases accepted: FirstName, LastName, LocationName, etc.

Fields

ParameterTypeRequiredDescription
firstnamestringYesFirst name (letters and spaces only).
lastnamestringYesLast name (letters and spaces only).
location_namestringYesLocation display name.
location_typestringYesWarehouse, Corporate Office, Retail Store, or Remote Employee.
contact_infostringYesPhone number (digits only).
contact_countrystringNoPhone country code (e.g. US).
emailstringYesUnique employee email.
address_1stringYesStreet address line 1.
address_2stringNoStreet address line 2.
citystringYesCity.
statestringNoState/province (required except UK).
zipstringYesPostal code.
countrystringYesCountry code or name (e.g. US).

Example Request Body

{
  "employees": [
    {
      "firstname": "John",
      "lastname": "Doe",
      "location_name": "San Francisco Remote Hub",
      "location_type": "Remote Employee",
      "contact_country": "US",
      "contact_info": "4155550198",
      "email": "john.doe@example.com",
      "address_1": "123 Market Street",
      "address_2": "Suite 400",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94103",
      "country": "US"
    },
    {
      "firstname": "Jane",
      "lastname": "Smith",
      "location_name": "San Francisco Remote Hub",
      "location_type": "Remote Employee",
      "contact_country": "US",
      "contact_info": "4155550198",
      "email": "jane.smith@example.com",
      "address_1": "123 Market Street",
      "address_2": "Suite 400",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94103",
      "country": "US"
    }
  ]
}

Response

Related Endpoints

Did this page help you?