Employee Detail

These endpoints let you manage detailed information about employees in the system. It allows you to retrieve and update comprehensive employee profiles, including personal, employment, and other related details.

Get Historical Employee Details

get

Return the historical employee details.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	:	Equal operator Support multiple values with each value separated by the ; delimiter
employee.id	:	Equal operator Support multiple values with each value separated by the ; delimiter
effectiveDate	<	Less than or equal to Use yyyy-MM-dd format, e.g. effectiveDate<2025-01-31

Example: {"summary":"Search Employee Details by Multiple IDs","value":"id:e18f5618-bc6c-11e6-80f5-76304dec7eb1;f38f5618-bc6c-11e6-80f5-76304dec7ec6"}

Responses

200

OK

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/employee-details

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employee-details?page=0&size=10&query=id%3Ae18f5618-bc6c-11e6-80f5-76304dec7eb1%3Bf38f5618-bc6c-11e6-80f5-76304dec7ec6" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "21c2f166-0099-437d-84dd-be09e0f42ec9",
      "bloodType": "A",
      "citizenship": {
        "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
        "code": "IDN",
        "callingCode": "+62",
        "name": "Indonesia",
        "taxTreaty": false
      },
      "dateOfBirth": "1990-03-31",
      "foreignLabour": false,
      "gender": "MALE",
      "maritalStatus": "SINGLE",
      "name": "John Doe",
      "placeOfBirth": {
        "id": "04e3c58f-b9f1-4d96-95eb-5f9a31fd9e8a",
        "code": "35.18",
        "name": "Kab. Nganjuk",
        "state": {
          "id": "71f5a7a0-a699-11e6-80f5-76304dec7eb7",
          "code": "35",
          "name": "East Java",
          "country": {
            "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
            "code": "IDN",
            "name": "Indonesia",
            "callingCode": "+62",
            "taxTreaty": false
          }
        }
      },
      "religion": {
        "id": "daa7f10k-a734-11e6-80f5-76304dec7eb7",
        "name": "Others",
        "code": "Others"
      },
      "effectiveDate": "2023-10-31",
      "createdBy": "system",
      "createdDate": 1481024187133,
      "updatedBy": "system",
      "updatedDate": 1481024187133,
      "employee": {
        "id": "e18f5618-bc6c-11e6-80f5-76304dec7eb1",
        "identificationNumber": "EMP12345",
        "name": "John Doe",
        "joinDate": "2022-08-15",
        "startDate": "2022-08-15",
        "active": true,
        "pointOfHire": {
          "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
          "code": "JKT-01",
          "name": "Jakarta Head Office",
          "locationGroup": {
            "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
            "code": "HQ",
            "name": "Headquarters"
          },
          "city": {
            "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
            "code": "31.70",
            "name": "Jakarta",
            "state": {
              "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
              "name": "Jakarta Special Capital Region",
              "code": "31",
              "country": {
                "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
                "code": "IDN",
                "callingCode": "62",
                "name": "Indonesia",
                "taxTreaty": true
              }
            }
          },
          "latitude": -6.2088,
          "longitude": 106.8456,
          "address": "Jl. Jenderal Sudirman Kav. 52-53",
          "phone": "[phone]",
          "zipCode": "12190",
          "headquarter": true,
          "company": {
            "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
            "code": "COMP-A",
            "name": "PT Example Company"
          }
        },
        "photo": {
          "url": "https://example.com/photos/john_doe.jpg"
        },
        "manager": {
          "id": "0100902f-5d8f-4de4-8fae-5ced86831dd1",
          "identificationNumber": "MGR5678",
          "name": "Jane Smith",
          "joinDate": "2020-01-14",
          "startDate": "2020-01-14",
          "active": true,
          "pointOfHire": {
            "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
            "code": "JKT-01",
            "name": "Jakarta Head Office",
            "locationGroup": {
              "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
              "code": "HQ",
              "name": "Headquarters"
            },
            "city": {
              "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
              "code": "31.70",
              "name": "Jakarta",
              "state": {
                "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
                "name": "Jakarta Special Capital Region",
                "code": "31",
                "country": {
                  "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
                  "code": "IDN",
                  "callingCode": "62",
                  "name": "Indonesia",
                  "taxTreaty": true
                }
              }
            },
            "latitude": -6.2088,
            "longitude": 106.8456,
            "address": "Jl. Jenderal Sudirman Kav. 52-53",
            "phone": "[phone]",
            "zipCode": "12190",
            "headquarter": true,
            "company": {
              "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
              "code": "COMP-A",
              "name": "PT Example Company"
            }
          },
          "photo": {
            "url": "https://example.com/photos/jane_smith.jpg"
          }
        }
      }
    },
    {
      "id": "0b37104b-6cad-4f23-ac73-5fdc9f822b8a",
      "bloodType": "B",
      "citizenship": {
        "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
        "code": "IDN",
        "callingCode": "+62",
        "name": "Indonesia",
        "taxTreaty": false
      },
      "dateOfBirth": "1980-03-31",
      "foreignLabour": false,
      "gender": "MALE",
      "maritalStatus": "MARRIED",
      "name": "Steven Smith",
      "placeOfBirth": {
        "id": "04e3c58f-b9f1-4d96-95eb-5f9a31fd9e8a",
        "code": "35.18",
        "name": "Kab. Nganjuk",
        "state": {
          "id": "71f5a7a0-a699-11e6-80f5-76304dec7eb7",
          "code": "35",
          "name": "East Java",
          "country": {
            "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
            "code": "IDN",
            "name": "Indonesia",
            "callingCode": "+62",
            "taxTreaty": false
          }
        }
      },
      "religion": {
        "id": "daa7f10k-a734-11e6-80f5-76304dec7eb7",
        "name": "Others",
        "code": "Others"
      },
      "effectiveDate": "2021-10-31",
      "createdBy": "system",
      "createdDate": 1481024187133,
      "updatedBy": "system",
      "updatedDate": 1481024187133,
      "employee": {
        "id": "e18f5618-bc6c-11e6-80f5-76304dec7eb1",
        "identificationNumber": "EMP12345",
        "name": "John Doe",
        "joinDate": "2022-08-15",
        "startDate": "2022-08-15",
        "active": true,
        "pointOfHire": {
          "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
          "code": "JKT-01",
          "name": "Jakarta Head Office",
          "locationGroup": {
            "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
            "code": "HQ",
            "name": "Headquarters"
          },
          "city": {
            "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
            "code": "31.70",
            "name": "Jakarta",
            "state": {
              "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
              "name": "Jakarta Special Capital Region",
              "code": "31",
              "country": {
                "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
                "code": "IDN",
                "callingCode": "62",
                "name": "Indonesia",
                "taxTreaty": true
              }
            }
          },
          "latitude": -6.2088,
          "longitude": 106.8456,
          "address": "Jl. Jenderal Sudirman Kav. 52-53",
          "phone": "[phone]",
          "zipCode": "12190",
          "headquarter": true,
          "company": {
            "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
            "code": "COMP-A",
            "name": "PT Example Company"
          }
        },
        "photo": {
          "url": "https://example.com/photos/john_doe.jpg"
        },
        "manager": {
          "id": "0100902f-5d8f-4de4-8fae-5ced86831dd1",
          "identificationNumber": "MGR5678",
          "name": "Jane Smith",
          "joinDate": "2020-01-14",
          "startDate": "2020-01-14",
          "active": true,
          "pointOfHire": {
            "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
            "code": "JKT-01",
            "name": "Jakarta Head Office",
            "locationGroup": {
              "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
              "code": "HQ",
              "name": "Headquarters"
            },
            "city": {
              "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
              "code": "31.70",
              "name": "Jakarta",
              "state": {
                "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
                "name": "Jakarta Special Capital Region",
                "code": "31",
                "country": {
                  "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
                  "code": "IDN",
                  "callingCode": "62",
                  "name": "Indonesia",
                  "taxTreaty": true
                }
              }
            },
            "latitude": -6.2088,
            "longitude": 106.8456,
            "address": "Jl. Jenderal Sudirman Kav. 52-53",
            "phone": "[phone]",
            "zipCode": "12190",
            "headquarter": true,
            "company": {
              "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
              "code": "COMP-A",
              "name": "PT Example Company"
            }
          },
          "photo": {
            "url": "https://example.com/photos/jane_smith.jpg"
          }
        }
      }
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 2,
  "numberOfElements": 2,
  "sort": [
    {
      "direction": "DESC",
      "property": "effectiveDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Employee Detail

get

The id field in the response refers to the employee's ID, not the employee detail's actual ID.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Responses

200

OK

application/json

idstringOptional

maritalStatusstring · enumOptionalPossible values:

foreignLabourbooleanOptional

namestringOptional

dateOfBirthstring · dateOptional

YYYY-MM-DD

genderstring · enumOptionalPossible values:

bloodTypestring · enumOptionalPossible values:

effectiveDatestring · dateOptional

YYYY-MM-DD

createdBystringOptional

createdDatenumberOptional

updatedBystringOptional

updatedDatenumberOptional

400

Bad Request

get

/core/v1/employees/{employeeId}/employee-details

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/employee-details" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "21c2f166-0099-437d-84dd-be09e0f42ec9",
  "bloodType": "A",
  "citizenship": {
    "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
    "code": "IDN",
    "callingCode": "+62",
    "name": "Indonesia",
    "taxTreaty": false
  },
  "dateOfBirth": "1990-03-31",
  "foreignLabour": false,
  "gender": "MALE",
  "maritalStatus": "SINGLE",
  "name": "John Doe",
  "placeOfBirth": {
    "id": "04e3c58f-b9f1-4d96-95eb-5f9a31fd9e8a",
    "code": "35.18",
    "name": "Kab. Nganjuk",
    "state": {
      "id": "71f5a7a0-a699-11e6-80f5-76304dec7eb7",
      "code": "35",
      "name": "East Java",
      "country": {
        "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
        "code": "IDN",
        "name": "Indonesia",
        "callingCode": "+62",
        "taxTreaty": false
      }
    }
  },
  "religion": {
    "id": "daa7f10k-a734-11e6-80f5-76304dec7eb7",
    "name": "Others",
    "code": "Others"
  },
  "effectiveDate": "2023-10-31",
  "createdBy": "system",
  "createdDate": 1481024187133,
  "updatedBy": "system",
  "updatedDate": 1481024187133,
  "employee": {
    "id": "e18f5618-bc6c-11e6-80f5-76304dec7eb1",
    "identificationNumber": "EMP12345",
    "name": "John Doe",
    "joinDate": "2022-08-15",
    "startDate": "2022-08-15",
    "active": true,
    "pointOfHire": {
      "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
      "code": "JKT-01",
      "name": "Jakarta Head Office",
      "locationGroup": {
        "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
        "code": "HQ",
        "name": "Headquarters"
      },
      "city": {
        "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
        "code": "31.70",
        "name": "Jakarta",
        "state": {
          "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
          "name": "Jakarta Special Capital Region",
          "code": "31",
          "country": {
            "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
            "code": "IDN",
            "callingCode": "62",
            "name": "Indonesia",
            "taxTreaty": true
          }
        }
      },
      "latitude": -6.2088,
      "longitude": 106.8456,
      "address": "Jl. Jenderal Sudirman Kav. 52-53",
      "phone": "[phone]",
      "zipCode": "12190",
      "headquarter": true,
      "company": {
        "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
        "code": "COMP-A",
        "name": "PT Example Company"
      }
    },
    "photo": {
      "url": "https://example.com/photos/john_doe.jpg"
    },
    "manager": {
      "id": "0100902f-5d8f-4de4-8fae-5ced86831dd1",
      "identificationNumber": "MGR5678",
      "name": "Jane Smith",
      "joinDate": "2020-01-14",
      "startDate": "2020-01-14",
      "active": true,
      "pointOfHire": {
        "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
        "code": "JKT-01",
        "name": "Jakarta Head Office",
        "locationGroup": {
          "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
          "code": "HQ",
          "name": "Headquarters"
        },
        "city": {
          "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
          "code": "31.70",
          "name": "Jakarta",
          "state": {
            "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
            "name": "Jakarta Special Capital Region",
            "code": "31",
            "country": {
              "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
              "code": "IDN",
              "callingCode": "62",
              "name": "Indonesia",
              "taxTreaty": true
            }
          }
        },
        "latitude": -6.2088,
        "longitude": 106.8456,
        "address": "Jl. Jenderal Sudirman Kav. 52-53",
        "phone": "[phone]",
        "zipCode": "12190",
        "headquarter": true,
        "company": {
          "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
          "code": "COMP-A",
          "name": "PT Example Company"
        }
      },
      "photo": {
        "url": "https://example.com/photos/jane_smith.jpg"
      }
    }
  }
}

Update Employee Detail

put

The id field in the response refers to the employee's ID, not the employee detail's actual ID.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Body

application/json

bloodTypestring · enumOptionalPossible values:

citizenshipIdstringRequired

Country ID

dateOfBirthstring · dateOptional

YYYY-MM-DD

Default: 1970-01-01

foreignLabourbooleanOptionalDefault: false

genderstring · enumOptionalPossible values:

maritalStatusstring · enumRequiredPossible values:

namestring · min: 1 · max: 255Required

placeOfBirthIdstringOptional

City ID

religionIdstringRequired

Responses

200

OK

application/json

idstringOptional

maritalStatusstring · enumOptionalPossible values:

foreignLabourbooleanOptional

namestringOptional

dateOfBirthstring · dateOptional

YYYY-MM-DD

genderstring · enumOptionalPossible values:

bloodTypestring · enumOptionalPossible values:

effectiveDatestring · dateOptional

YYYY-MM-DD

createdBystringOptional

createdDatenumberOptional

updatedBystringOptional

updatedDatenumberOptional

400

Bad Request

put

/core/v1/employees/{employeeId}/employee-details

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/employee-details" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "bloodType": "A",
  "citizenshipId": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
  "dateOfBirth": "1990-03-31",
  "foreignLabour": false,
  "gender": "MALE",
  "maritalStatus": "SINGLE",
  "name": "Alice",
  "placeOfBirthId": "04e3c58f-b9f1-4d96-95eb-5f9a31fd9e8a",
  "religionId": "daa7f10k-a734-11e6-80f5-76304dec7eb7"
}'

{
  "id": "21c2f166-0099-437d-84dd-be09e0f42ec9",
  "bloodType": "A",
  "citizenship": {
    "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
    "code": "IDN",
    "callingCode": "+62",
    "name": "Indonesia",
    "taxTreaty": false
  },
  "dateOfBirth": "1990-03-31",
  "foreignLabour": false,
  "gender": "MALE",
  "maritalStatus": "SINGLE",
  "name": "John Doe",
  "placeOfBirth": {
    "id": "04e3c58f-b9f1-4d96-95eb-5f9a31fd9e8a",
    "code": "35.18",
    "name": "Kab. Nganjuk",
    "state": {
      "id": "71f5a7a0-a699-11e6-80f5-76304dec7eb7",
      "code": "35",
      "name": "East Java",
      "country": {
        "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
        "code": "IDN",
        "name": "Indonesia",
        "callingCode": "+62",
        "taxTreaty": false
      }
    }
  },
  "religion": {
    "id": "daa7f10k-a734-11e6-80f5-76304dec7eb7",
    "name": "Others",
    "code": "Others"
  },
  "effectiveDate": "2023-10-31",
  "createdBy": "system",
  "createdDate": 1481024187133,
  "updatedBy": "system",
  "updatedDate": 1481024187133,
  "employee": {
    "id": "e18f5618-bc6c-11e6-80f5-76304dec7eb1",
    "identificationNumber": "EMP12345",
    "name": "John Doe",
    "joinDate": "2022-08-15",
    "startDate": "2022-08-15",
    "active": true,
    "pointOfHire": {
      "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
      "code": "JKT-01",
      "name": "Jakarta Head Office",
      "locationGroup": {
        "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
        "code": "HQ",
        "name": "Headquarters"
      },
      "city": {
        "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
        "code": "31.70",
        "name": "Jakarta",
        "state": {
          "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
          "name": "Jakarta Special Capital Region",
          "code": "31",
          "country": {
            "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
            "code": "IDN",
            "callingCode": "62",
            "name": "Indonesia",
            "taxTreaty": true
          }
        }
      },
      "latitude": -6.2088,
      "longitude": 106.8456,
      "address": "Jl. Jenderal Sudirman Kav. 52-53",
      "phone": "[phone]",
      "zipCode": "12190",
      "headquarter": true,
      "company": {
        "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
        "code": "COMP-A",
        "name": "PT Example Company"
      }
    },
    "photo": {
      "url": "https://example.com/photos/john_doe.jpg"
    },
    "manager": {
      "id": "0100902f-5d8f-4de4-8fae-5ced86831dd1",
      "identificationNumber": "MGR5678",
      "name": "Jane Smith",
      "joinDate": "2020-01-14",
      "startDate": "2020-01-14",
      "active": true,
      "pointOfHire": {
        "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
        "code": "JKT-01",
        "name": "Jakarta Head Office",
        "locationGroup": {
          "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
          "code": "HQ",
          "name": "Headquarters"
        },
        "city": {
          "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
          "code": "31.70",
          "name": "Jakarta",
          "state": {
            "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
            "name": "Jakarta Special Capital Region",
            "code": "31",
            "country": {
              "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
              "code": "IDN",
              "callingCode": "62",
              "name": "Indonesia",
              "taxTreaty": true
            }
          }
        },
        "latitude": -6.2088,
        "longitude": 106.8456,
        "address": "Jl. Jenderal Sudirman Kav. 52-53",
        "phone": "[phone]",
        "zipCode": "12190",
        "headquarter": true,
        "company": {
          "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
          "code": "COMP-A",
          "name": "PT Example Company"
        }
      },
      "photo": {
        "url": "https://example.com/photos/jane_smith.jpg"
      }
    }
  }
}