---
title: "POST /people"
method: POST
path: "/people"
tags: ["People"]
---

# POST /people

`POST /people`

## Request

- Base URL: `https://api.intellihr.io`
- URL: `https://api.intellihr.io/people`
- Auth: API key in header `Authorization`

Create a person

## Request body

- PeopleCreate
  - `dateOfBirth` string, nullable: Date of Birth (Y-m-d)
  - `emergencyContactEmail` string: Emergency Contact Email
  - `emergencyContactName` string: Emergency Contact Name
  - `emergencyContactPhone` string: Emergency Contact Phone
  - `emergencyContactPhoneCountryId` ResourceId (unresolved $ref)
  - `emergencyContactRelationship` string: Emergency Contact Relationship
  - `employeeNumber` string, nullable: Employee Number
  - `firstName` string: First Name
  - `gender` string: Human readable gender name. If `genderId` is also provided, this parameter will be ignored. Searching is done case-insensitively and 'starts-with' e.g. passing `male` will match with a [Gender](#tags/genders) called `Male` as will `m` or `M`. If multiple [Genders](#tags/genders) match the first will be chosen.
  - `genderId` ResourceId (unresolved $ref)
  - `lastName` string, required: Last Name
  - `middleName` string: Middle Name(s)
  - `preferredName` string: Preferred Name
  - `titleId` ResourceId (unresolved $ref)
  - `emailAddresses` object[], nullable: Array of Email Addresses.
    - `isPersonal` boolean: Denotes if this Email Address is Personal
    - `isPrimary` boolean: This flag is used for notifications. Only one `Primary` Email Address is allowed per person. If you add a new `Primary` Email Address, any existing `Primary` Email Address marks will be cleared.
    - `email` string, required
    - `name` string: A logical identifier for this Email Address entry.
  - `phoneNumbers` object[], nullable: Array of Phone Numbers
    - `isPersonal` boolean: Denotes if this Phone Number is Personal
    - `isPrimary` boolean: This flag is used for notifications. Only one `Primary` Phone Number is allowed per person. If you add a new `Primary` Phone Number, any existing `Primary` Phone Number marks will be cleared.
    - `phone` string, required
    - `countryId` ResourceId (unresolved $ref)

## Response `201`

Created Successfully

- People
  - `data` object
    - `type` string: The name of the data model that is being returned
    - `id` ResourceId (unresolved $ref)
    - `attributes` object
      - `preferredName` string: Every employee has an option to set a preferred name.
      - `preferredOrFirstName` string: Will return preferredName, or, if preferredName is not set, will return fistName
      - `firstName` string
      - `middleNames` string
      - `lastName` string
      - `displayName` string: Will follow the following pattern: `preferredName (firstName) lastName`
      - `legalName` string: Has the following pattern: `firstName middleNames lastName`
      - `dateOfBirth` string: Date of Birth (Y-m-d)
      - `gender` string: Human readable string for the persons gender
      - `genderId` ResourceId (unresolved $ref)
      - `employeeNumber` string: A manually entered employee number that identifies a [Person](#tags/people) in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.
      - `intellihrId` number: An auto generated number that uniquely identifies a [Person](#tags/people) in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.
      - `titleId` ResourceId (unresolved $ref)
      - `emergencyContact` object
        - `name` string: First and last names of the emergency contact
        - `relationship` string
        - `phone` string
        - `email` string
      - `profilePictureId` ResourceId (unresolved $ref)
      - `profileCoverPictureId` ResourceId (unresolved $ref)
      - `workRightExpiryDate` RfcDateTime (unresolved $ref)
      - `employmentStatus` 'Current Staff' | 'Exiting Staff' | 'No Job Records' | 'Past Staff' | 'Returning Staff' | 'Upcoming Staff'
      - `jobs` object[]: An array of Job entries associated with this Person
        - `id` ResourceId (unresolved $ref)
        - `name` string
        - `startDate` RfcDateTime (unresolved $ref)
        - `endDate` RfcDateTime (unresolved $ref)
        - `createdAt` RfcDateTime (unresolved $ref)
        - `updatedAt` RfcDateTime (unresolved $ref)
      - `emailAddresses` object[]: An array of Email Addresses associated with this [Person](#tags/people)
        - `id` ResourceId (unresolved $ref)
        - `email` string: The email address
        - `isPrimary` boolean: Specifies if this email address is their primary address used for sending emails
        - `isPersonal` boolean: Specifies if this email address is owned personally (i.e. not handed out by the company)
      - `createdAt` RfcDateTime (unresolved $ref)
      - `updatedAt` RfcDateTime (unresolved $ref)

## Other responses

- `400` (unresolved $ref)
- `403` (unresolved $ref)
- `500` (unresolved $ref)

---

[API](https://skmtc.dev/intellihr/apis/intellihr-public-api.md) · [All operations](https://skmtc.dev/intellihr/apis/intellihr-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/intellihr/apis/intellihr-public-api/revisions/6529279c999b?raw)