GET
/
api
/
v2
/
employee_list
Get Employee List (v2)
curl --request GET \
  --url https://{env}.tartanhq.com/api/v2/employee_list \
  --header 'Authorization: <api-key>'
{
  "requestId": "0712451b-6672-4293-a7a6-6b75f5b15590",
  "message": "success",
  "pageInfo": {
    "totalPages": 4,
    "totalItems": 97,
    "items": 25,
    "next": true,
    "previous": false
  },
  "data": [
    {
      "id": "7",
      "employeeId": "5",
      "name": "Manas Mallik",
      "email": "manas@tartanhq.com",
      "personalEmail": "manas.mallik@gmail.com",
      "doj": "2021-06-01",
      "dob": "1983-06-08",
      "status": "Active",
      "employmentType": "Permanent",
      "gender": "Male",
      "pan": "************",
      "aadhar": "************",
      "uan": "************",
      "mobileNumber": "************",
      "maritalStatus": "Married",
      "nationality": "Indian",
      "fatherName": "Ritesh Mallik",
      "bloodGroup": "AB +ve",
      "designation": "NOT AVAILABLE",
      "department": "Engineering",
      "grade": "D-3",
      "groupName": "NOT AVAILABLE",
      "costCenter": "NOT AVAILABLE",
      "companyName": "NOT AVAILABLE",
      "terminationDate": "",
      "manager": "Meet Semlani",
      "managerEmail": "NOT AVAILABLE",
      "managerEmail2": "NOT AVAILABLE",
      "managerEmail3": "NOT AVAILABLE",
      "managerEmail4": "NOT AVAILABLE",
      "managerEmail5": "NOT AVAILABLE",
      "countryCode": "IN",
      "bankDetails": {
        "accountNumber": "************",
        "ifscCode": "************",
        "bankName": "SBI"
      },
      "currentAddress": {
        "addressPincode": "560080",
        "addressCity": "Banglore",
        "addressCountry": "India",
        "addressState": "Karnataka",
        "addressLine": "Sadashiva Nagar Armane Nagar"
      },
      "permanentAddress": {
        "addressPincode": "226001",
        "addressCity": "Luknow",
        "addressCountry": "India",
        "addressState": "Uttar Pradesh",
        "addressLine": "Yarana Nagar Luknow"
      },
      "jobLocation": {
        "pincode": "NOT AVAILABLE",
        "city": "NOT AVAILABLE"
      },
      "employeeMetadata": {
        "marriageDate": "NOT AVAILABLE"
      },
      "dependentDetails": [
        {
          "name": "Sohan Negi",
          "relation": "Father",
          "dob": "NOT AVAILABLE",
          "email": "NOT AVAILABLE",
          "gender": "NOT AVAILABLE",
          "mobileNumber": "NOT AVAILABLE",
          "profession": "NOT AVAILABLE"
        }
      ]
    }
  ]
}
Enum Mapping
If an unexpected value is received for any enum-based key, and it doesn’t match any value in the enum mapping, the value will be set to null.
Field nameTartan Enum value / Format
dob%Y-%m-%d
doj%Y-%m-%d
terminationDate%Y-%m-%d
dependentDetails.dob%Y-%m-%d
status["Active", "Not Active"]
employmentType["Permanent", "Contract", "Probation/Intern"]
gender["Male", "Female", "Other"]
maritalStatus["Single", "Married", "Divorced", "Widowed"]
dependentDetails.gender["Male", "Female", "Other"]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
org
string
required

The organization identifier.

​
page
integer

The page number to fetch.

​
size
integer

Number of employees to return per page.

​
from_date
string<date-time>

Return employees updated after this date.

​
source
string

Data source (e.g., db, hrms).

​
filter
string

Filter in the format field:value, e.g., status:active.

Response

Successful response

​
requestId
string
Example:

"0712451b-6672-4293-a7a6-6b75f5b15590"

​
message
string
Example:

"success"

​
pageInfo
object
​
data
object[]