Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-1325119255.7 KB
Employees

Create Employee

Create Employee

post/hris/employees

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring nullable

A unique identifier for an object.

downstream_idstring nullable

The third-party API ID of original entity

first_namestring nullable

The first name of the person.

last_namestring nullable

The last name of the person.

middle_namestring nullable

Middle name of the person.

display_namestring nullable

The name used to display the employee, often a combination of their first and last names.

preferred_namestring nullable

The name the employee prefers to be addressed by, which may be different from their legal name.

initialsstring nullable

The initials of the person, usually derived from their first, middle, and last names.

salutationstring nullable

A formal salutation for the person. For example, 'Mr', 'Mrs'

titlestring nullable

The job title of the person.

marital_statusstring nullable

The marital status of the employee.

divisionstring nullable

The division the person is currently in. Usually a collection of departments or teams or regions.

division_idstring nullable

Unique identifier of the division this employee belongs to.

departmentstring nullable

The department the person is currently in. Deprecated in favor of the dedicated department_id and department_name field.

department_idstring nullable

Unique identifier of the department ID this employee belongs to.

department_namestring nullable

Name of the department this employee belongs to.

company_idstring nullable

The unique identifier of the company.

company_namestring nullable

The name of the company.

employment_start_datestring nullable

A Start Date is the date that the employee started working at the company

employment_end_datestring nullable

An End Date is the date that the employee ended working at the company

leaving_reason'dismissed' | 'resigned' | 'redundancy' | 'retired' | 'other' nullable

The reason because the employment ended.

employee_numberstring nullable

An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.

employment_status'active' | 'inactive' | 'terminated' | 'other' nullable

The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.

ethnicitystring nullable

The ethnicity of the employee

direct_reportsstring[] nullable

Direct reports is an array of ids that reflect the individuals in an organizational hierarchy who are directly supervised by this specific employee.

social_security_numberstring nullable

A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.

birthdaystring date nullable

The date of birth of the person.

deceased_onstring date nullable

The date the person deceased.

country_of_birthstring nullable

Country code according to ISO 3166-1 alpha-2.

descriptionstring nullable

A description of the object.

gender'male' | 'female' | 'unisex' | 'other' | 'not_specified' nullable

The gender represents the gender identity of a person.

pronounsstring nullable

The preferred pronouns of the person.

preferred_languagestring nullable

language code according to ISO 639-1. For the United States - EN

languagesLanguage[]
nationalitiesNationality[]
photo_urlstring nullable

The URL of the photo of a person.

timezonestring nullable

The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London.

sourcestring nullable

When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from.

source_idstring nullable

Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).

record_urlstring nullable
works_remoteboolean nullable

Indicates if the employee works from a remote location.

tax_codestring nullable
tax_idstring nullable
dietary_preferencestring nullable

Indicate the employee's dietary preference.

food_allergiesstring[] nullable

Indicate the employee's food allergies.

tagsstring[] nullable
custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

row_versionstring nullable

A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.

deletedboolean nullable

Flag to indicate if the object is deleted.

updated_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "id": "12345",
  "downstream_id": "12345",
  "first_name": "Elon",
  "last_name": "Musk",
  "middle_name": "D.",
  "display_name": "Technoking",
  "preferred_name": "Elon Musk",
  "initials": "EM",
  "salutation": "Mr",
  "title": "CEO",
  "marital_status": "married",
  "partner": {
    "id": "12345",
    "first_name": "Elon",
    "last_name": "Musk",
    "middle_name": "D.",
    "gender": "male",
    "initials": "EM",
    "birthday": "2000-08-12",
    "deceased_on": "2000-08-12"
  },
  "division": "Europe",
  "division_id": "12345",
  "department": "R&D",
  "department_id": "12345",
  "department_name": "12345",
  "team": {
    "id": "1234",
    "name": "Full Stack Engineers"
  },
  "company_id": "23456",
  "company_name": "SpaceX",
  "employment_start_date": "2021-10-26",
  "employment_end_date": "2028-10-26",
  "leaving_reason": "resigned",
  "employee_number": "123456-AB",
  "employment_status": "active",
  "ethnicity": "African American",
  "manager": {
    "id": "12345",
    "name": "Elon Musk",
    "first_name": "Elon",
    "last_name": "Musk",
    "email": "elon@musk.com",
    "employment_status": "active"
  },
  "direct_reports": [
    "a0d636c6-43b3-4bde-8c70-85b707d992f4",
    "a98lfd96-43b3-4bde-8c70-85b707d992e6"
  ],
  "social_security_number": "123456789",
  "birthday": "2000-08-12",
  "deceased_on": "2000-08-12",
  "country_of_birth": "US",
  "description": "A description",
  "gender": "male",
  "pronouns": "she,her",
  "preferred_language": "EN",
  "languages": [
    "EN"
  ],
  "nationalities": [
    "US"
  ],
  "photo_url": "https://unavatar.io/elon-musk",
  "timezone": "Europe/London",
  "source": "lever",
  "source_id": "12345",
  "record_url": "https://app.intercom.io/contacts/12345",
  "jobs": [
    {
      "id": "12345",
      "employee_id": "12345",
      "title": "CEO",
      "role": "Sales",
      "start_date": "2020-08-12",
      "end_date": "2020-08-12",
      "compensation_rate": 72000,
      "currency": "USD",
      "payment_unit": "year",
      "hired_at": "2020-08-12",
      "is_primary": true,
      "is_manager": true,
      "status": "active",
      "location": {
        "id": "123",
        "type": "primary",
        "string": "25 Spring Street, Blackburn, VIC 3130",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "line3": "Suite #",
        "line4": "delivery instructions",
        "line5": "Attention: Finance Dept",
        "street_number": "25",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638",
        "county": "Santa Clara",
        "contact_name": "Elon Musk",
        "salutation": "Mr",
        "phone_number": "111-111-1111",
        "fax": "122-111-1111",
        "email": "elon@musk.com",
        "website": "https://elonmusk.com",
        "notes": "Address notes or delivery instructions.",
        "row_version": "1-12345"
      }
    }
  ],
  "compensations": [
    {
      "id": "3404301363494309004",
      "job_id": "3490439050957906679",
      "rate": 50,
      "payment_unit": "hour",
      "flsa_status": "nonexempt",
      "effective_date": "2021-06-11"
    }
  ],
  "works_remote": true,
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "line5": "Attention: Finance Dept",
      "street_number": "25",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638",
      "county": "Santa Clara",
      "contact_name": "Elon Musk",
      "salutation": "Mr",
      "phone_number": "111-111-1111",
      "fax": "122-111-1111",
      "email": "elon@musk.com",
      "website": "https://elonmusk.com",
      "notes": "Address notes or delivery instructions.",
      "row_version": "1-12345"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck",
      "type": "twitter"
    }
  ],
  "bank_accounts": [
    {
      "bank_name": "Chase Bank",
      "account_number": "123465",
      "account_name": "Main Operating Account",
      "account_type": "credit_card",
      "iban": "GB33BUKB20201555555555",
      "bic": "CHASUS33",
      "routing_number": "021000021",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD",
      "country": "US"
    }
  ],
  "tax_code": "1111",
  "tax_id": "234-32-0000",
  "dietary_preference": "Veggie",
  "food_allergies": [
    "No allergies"
  ],
  "probation_period": {
    "start_date": "2021-10-01",
    "end_date": "2021-11-28"
  },
  "tags": [
    "New"
  ],
  "row_version": "1-12345",
  "deleted": true,
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Employees

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "sage-hr",
  "resource": "Employees",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}