Skip to main content
GET
Get Employee List (v2)
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"

corporateReferenceId
string
Example:

"f8302566-7464-492a-a485-e8998f97a07f"

message
string
Example:

"success"

pageInfo
object
data
object[]