Employment Status

These endpoints let you manage employment statuses in the system. It allows you to retrieve, create, update, and delete employment status records.

Get Employment Statuses

get

Return the employment statuses.

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

Example: {"summary":"Search Employment Statuses 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/employment-statuses

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employment-statuses?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": "5540d712-508c-4831-84a6-8433933409d6",
      "employmentStatusNumber": "PKWT-111",
      "organization": {
        "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb7",
        "code": "ORG-002",
        "name": "ICT",
        "type": "FUNCTIONAL",
        "createdBy": "system",
        "createdDate": 1481024187133,
        "updatedBy": "system",
        "updatedDate": 1481024187133,
        "company": {
          "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb6",
          "code": "COMP-001",
          "name": "PT ABC"
        },
        "organizationHierarchy": {
          "id": "a896d062-aba9-11e6-80f5-76304dec7eb7",
          "code": "ORG-002",
          "name": "Departemen ICT",
          "color": "#B7783A",
          "level": 2
        },
        "organizationGroup": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "OG-001",
          "name": "Organization Group"
        },
        "organizationParent": {}
      },
      "jobTitle": {
        "id": "3fb954ed-f00d-4f6f-b9ee-35f3ef817df9",
        "code": "JT010",
        "name": "Staff",
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31",
        "minJobLevel": {
          "id": "4211c096-4c06-4cce-8bf3-c6060a46ac34",
          "code": "JL-01",
          "name": "Job Level 1",
          "effectiveDate": "2021-01-31",
          "endDate": "9999-12-31",
          "jobPosition": {
            "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
            "code": "JP-001",
            "name": "Job Position Name"
          },
          "level": 1
        },
        "maxJobLevel": {
          "id": "1211c096-4c06-4cce-8bf3-c6060a46ac34",
          "code": "JL-07",
          "name": "Job Level 7",
          "effectiveDate": "2021-01-31",
          "endDate": "9999-12-31",
          "jobPosition": {
            "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
            "code": "JP-007",
            "name": "Job Position Name"
          },
          "level": 6
        }
      },
      "jobLevel": {
        "id": "944e67fc-3ac4-463d-9854-db536f4dad56",
        "code": "JL-020",
        "name": "Staff",
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31",
        "jobPosition": {
          "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
          "code": "JP-001",
          "name": "Job Position Name"
        },
        "level": 1
      },
      "location": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb9",
        "code": "LOC-001",
        "name": "Location Name",
        "locationGroup": {
          "id": "81d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "LG-001",
          "name": "Location Group Name"
        },
        "city": {
          "id": "31d5f69a-a5a4-1111-80f5-76304dec7eb2",
          "code": "31.70",
          "name": "Jakarta",
          "state": {
            "id": "51d5f69a-a5a4-1111-80f5-76304dec7eb3",
            "code": "35",
            "name": "East Java",
            "country": {
              "id": "11d5f69a-a5a4-1111-80f5-76304dec7eb1",
              "code": "IDN",
              "name": "Indonesia"
            }
          }
        },
        "address": "Menara Citicon, 17th Floor, Jl. Letjen. S. Parman Kav 72",
        "phone": "[phone]",
        "zipCode": "11410",
        "headquarter": true,
        "latitude": -6.174465,
        "longitude": 106.827153,
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "COMP-001",
          "name": "PT. CATAPA"
        },
        "effectiveDate": "2023-01-01",
        "endDate": "9999-12-31"
      },
      "costCenter": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb1",
        "code": "CC-001",
        "name": "Cost Center Name",
        "description": "Cost Center Description",
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "COMP-001",
          "name": "PT. CATAPA"
        }
      },
      "employmentType": {
        "id": "a896cc20-aba9-11e6-80f6-76304dec7eb7",
        "name": "Permanent",
        "employmentGroupCode": "EGC-001",
        "permanent": false,
        "monthDuration": 8,
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31"
      },
      "employmentStatusType": {
        "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb3",
        "name": "Permanent",
        "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
        "defaultData": false
      },
      "contractStart": "2021-01-31",
      "contractEnd": "2023-01-31",
      "signDate": "2021-01-31",
      "effectiveDate": "2021-01-31",
      "permanentDate": "2021-01-31",
      "createdBy": "system",
      "createdDate": 1481024187133,
      "updatedBy": "system",
      "updatedDate": 1481024187133,
      "subLocation": {
        "id": "81d5f69a-a5a4-1111-80f5-76304dec7db8",
        "code": "SL-001",
        "name": "Sub Location Name",
        "location": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7ej2",
          "code": "LOC-005",
          "name": "Location Name",
          "company": {
            "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
            "code": "COMP-001",
            "name": "PT. CATAPA"
          },
          "effectiveDate": "2022-01-01",
          "endDate": "9999-12-31"
        },
        "effectiveDate": "2022-01-01",
        "endDate": "9999-12-31"
      },
      "operationalGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb2",
        "code": "OG-001",
        "name": "Operational Group Name"
      },
      "position": {
        "id": "31d5f69a-a5a4-1111-80f5-76304dec7eb3",
        "code": "POS-001",
        "name": "Position Name",
        "effectiveDate": "2021-01-31",
        "endDate": "2099-12-31"
      }
    },
    {
      "id": "3540d712-508c-4831-84a6-8433933409d2",
      "employmentStatusNumber": "PKWT-222",
      "organization": {
        "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb7",
        "code": "ORG-002",
        "name": "ICT",
        "type": "FUNCTIONAL",
        "createdBy": "system",
        "createdDate": 1481024187133,
        "updatedBy": "system",
        "updatedDate": 1481024187133,
        "company": {
          "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb6",
          "code": "COMP-001",
          "name": "PT ABC"
        },
        "organizationHierarchy": {
          "id": "a896d062-aba9-11e6-80f5-76304dec7eb7",
          "code": "ORG-002",
          "name": "Departemen ICT",
          "color": "#B7783A",
          "level": 2
        },
        "organizationGroup": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "OG-001",
          "name": "Organization Group"
        },
        "organizationParent": {}
      },
      "jobTitle": {
        "id": "3fb954ed-f00d-4f6f-b9ee-35f3ef817df9",
        "code": "JT010",
        "name": "Staff",
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31",
        "minJobLevel": {
          "id": "4211c096-4c06-4cce-8bf3-c6060a46ac34",
          "code": "JL-01",
          "name": "Job Level 1",
          "effectiveDate": "2021-01-31",
          "endDate": "9999-12-31",
          "jobPosition": {
            "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
            "code": "JP-001",
            "name": "Job Position Name"
          },
          "level": 1
        },
        "maxJobLevel": {
          "id": "1211c096-4c06-4cce-8bf3-c6060a46ac34",
          "code": "JL-07",
          "name": "Job Level 7",
          "effectiveDate": "2021-01-31",
          "endDate": "9999-12-31",
          "jobPosition": {
            "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
            "code": "JP-007",
            "name": "Job Position Name"
          },
          "level": 6
        }
      },
      "jobLevel": {
        "id": "944e67fc-3ac4-463d-9854-db536f4dad56",
        "code": "JL-020",
        "name": "Staff",
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31",
        "jobPosition": {
          "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
          "code": "JP-001",
          "name": "Job Position Name"
        },
        "level": 1
      },
      "location": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb9",
        "code": "LOC-001",
        "name": "Location Name",
        "locationGroup": {
          "id": "81d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "LG-001",
          "name": "Location Group Name"
        },
        "city": {
          "id": "31d5f69a-a5a4-1111-80f5-76304dec7eb2",
          "code": "31.70",
          "name": "Jakarta",
          "state": {
            "id": "51d5f69a-a5a4-1111-80f5-76304dec7eb3",
            "code": "35",
            "name": "East Java",
            "country": {
              "id": "11d5f69a-a5a4-1111-80f5-76304dec7eb1",
              "code": "IDN",
              "name": "Indonesia"
            }
          }
        },
        "address": "Menara Citicon, 17th Floor, Jl. Letjen. S. Parman Kav 72",
        "phone": "[phone]",
        "zipCode": "11410",
        "headquarter": true,
        "latitude": -6.174465,
        "longitude": 106.827153,
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "COMP-001",
          "name": "PT. CATAPA"
        },
        "effectiveDate": "2023-01-01",
        "endDate": "9999-12-31"
      },
      "costCenter": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb2",
        "code": "CC-002",
        "name": "Cost Center Name 2",
        "description": "Cost Center Description",
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "COMP-001",
          "name": "PT. CATAPA"
        }
      },
      "employmentType": {
        "id": "a896cc20-aba9-11e6-80f6-76304dec7eb7",
        "name": "Permanent",
        "employmentGroupCode": "EGC-001",
        "permanent": false,
        "monthDuration": 8,
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31"
      },
      "employmentStatusType": {
        "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb3",
        "name": "Permanent",
        "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
        "defaultData": false
      },
      "contractStart": "2021-01-31",
      "contractEnd": "2023-01-31",
      "signDate": "2021-01-31",
      "effectiveDate": "2021-01-31",
      "permanentDate": "2021-01-31",
      "createdBy": "system",
      "createdDate": 1481024187133,
      "updatedBy": "system",
      "updatedDate": 1481024187133,
      "subLocation": {
        "id": "81d5f69a-a5a4-1111-80f5-76304dec7db8",
        "code": "SL-001",
        "name": "Sub Location Name",
        "location": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7ej2",
          "code": "LOC-005",
          "name": "Location Name",
          "company": {
            "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
            "code": "COMP-001",
            "name": "PT. CATAPA"
          },
          "effectiveDate": "2022-01-01",
          "endDate": "9999-12-31"
        },
        "effectiveDate": "2022-01-01",
        "endDate": "9999-12-31"
      },
      "operationalGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb2",
        "code": "OG-001",
        "name": "Operational Group Name"
      },
      "position": {
        "id": "31d5f69a-a5a4-1111-80f5-76304dec7eb3",
        "code": "POS-001",
        "name": "Position Name",
        "effectiveDate": "2021-01-31",
        "endDate": "2099-12-31"
      }
    }
  ],
  "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 Employment Status Histories

get

Return the employment status histories.

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 Employment Status Histories 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/employment-status-histories

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employment-status-histories?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": "5540d712-508c-4831-84a6-8433933409d6",
      "employmentStatusNumber": "PKWT-111",
      "organization": {
        "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb7",
        "code": "ORG-002",
        "name": "ICT",
        "type": "FUNCTIONAL",
        "company": {
          "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb6",
          "code": "COMP-001",
          "name": "PT ABC"
        },
        "organizationHierarchy": {
          "id": "a896d062-aba9-11e6-80f5-76304dec7eb7",
          "code": "ORG-002",
          "name": "Departemen ICT",
          "color": "#B7783A",
          "level": 2
        },
        "organizationGroup": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "OG-001",
          "name": "Organization Group"
        },
        "organizationParent": {}
      },
      "jobTitle": {
        "id": "3fb954ed-f00d-4f6f-b9ee-35f3ef817df9",
        "code": "JT010",
        "name": "Staff",
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31",
        "minJobLevel": {
          "id": "4211c096-4c06-4cce-8bf3-c6060a46ac34",
          "code": "JL-01",
          "name": "Job Level 1",
          "effectiveDate": "2021-01-31",
          "endDate": "9999-12-31",
          "jobPosition": {
            "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
            "code": "JP-001",
            "name": "Job Position Name"
          },
          "level": 1
        },
        "maxJobLevel": {
          "id": "1211c096-4c06-4cce-8bf3-c6060a46ac34",
          "code": "JL-07",
          "name": "Job Level 7",
          "effectiveDate": "2021-01-31",
          "endDate": "9999-12-31",
          "jobPosition": {
            "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
            "code": "JP-007",
            "name": "Job Position Name"
          },
          "level": 6
        }
      },
      "jobLevel": {
        "id": "944e67fc-3ac4-463d-9854-db536f4dad56",
        "code": "JL-020",
        "name": "Staff",
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31",
        "jobPosition": {
          "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
          "code": "JP-001",
          "name": "Job Position Name"
        },
        "level": 1
      },
      "location": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb9",
        "code": "LOC-001",
        "name": "Location Name",
        "locationGroup": {
          "id": "81d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "LG-001",
          "name": "Location Group Name"
        },
        "city": {
          "id": "31d5f69a-a5a4-1111-80f5-76304dec7eb2",
          "code": "31.70",
          "name": "Jakarta",
          "state": {
            "id": "51d5f69a-a5a4-1111-80f5-76304dec7eb3",
            "code": "35",
            "name": "East Java",
            "country": {
              "id": "11d5f69a-a5a4-1111-80f5-76304dec7eb1",
              "code": "IDN",
              "name": "Indonesia"
            }
          }
        },
        "address": "Menara Citicon, 17th Floor, Jl. Letjen. S. Parman Kav 72",
        "phone": "[phone]",
        "zipCode": "11410",
        "headquarter": true,
        "latitude": -6.174465,
        "longitude": 106.827153,
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "COMP-001",
          "name": "PT. CATAPA"
        },
        "effectiveDate": "2023-01-01",
        "endDate": "9999-12-31"
      },
      "costCenter": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb1",
        "code": "CC-001",
        "name": "Cost Center Name",
        "description": "Cost Center Description",
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "COMP-001",
          "name": "PT. CATAPA"
        }
      },
      "employmentType": {
        "id": "a896cc20-aba9-11e6-80f6-76304dec7eb7",
        "name": "Permanent",
        "employmentGroupCode": "EGC-001",
        "permanent": false,
        "monthDuration": 8,
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31"
      },
      "employmentStatusType": {
        "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb3",
        "name": "Permanent",
        "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
        "defaultData": false
      },
      "contractStart": "2021-01-31",
      "contractEnd": "2023-01-31",
      "signDate": "2021-01-31",
      "effectiveDate": "2021-01-31",
      "endDate": "1970-01-01",
      "permanentDate": "2021-01-31",
      "subLocation": {
        "id": "81d5f69a-a5a4-1111-80f5-76304dec7db8",
        "code": "SL-001",
        "name": "Sub Location Name",
        "location": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7ej2",
          "code": "LOC-005",
          "name": "Location Name",
          "company": {
            "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
            "code": "COMP-001",
            "name": "PT. CATAPA"
          },
          "effectiveDate": "2022-01-01",
          "endDate": "9999-12-31"
        },
        "effectiveDate": "2022-01-01",
        "endDate": "9999-12-31"
      },
      "operationalGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb2",
        "code": "OG-001",
        "name": "Operational Group Name"
      },
      "position": {
        "id": "31d5f69a-a5a4-1111-80f5-76304dec7eb3",
        "code": "POS-001",
        "name": "Position Name",
        "effectiveDate": "2021-01-31",
        "endDate": "1970-01-01"
      },
      "employee": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "identificationNumber": "EMP-001"
      }
    },
    {
      "id": "3540d712-508c-4831-84a6-8433933409d2",
      "employmentStatusNumber": "PKWT-222",
      "organization": {
        "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb7",
        "code": "ORG-002",
        "name": "ICT",
        "type": "FUNCTIONAL",
        "company": {
          "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb6",
          "code": "COMP-001",
          "name": "PT ABC"
        },
        "organizationHierarchy": {
          "id": "a896d062-aba9-11e6-80f5-76304dec7eb7",
          "code": "ORG-002",
          "name": "Departemen ICT",
          "color": "#B7783A",
          "level": 2
        },
        "organizationGroup": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "OG-001",
          "name": "Organization Group"
        },
        "organizationParent": {}
      },
      "jobTitle": {
        "id": "3fb954ed-f00d-4f6f-b9ee-35f3ef817df9",
        "code": "JT010",
        "name": "Staff",
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31",
        "minJobLevel": {
          "id": "4211c096-4c06-4cce-8bf3-c6060a46ac34",
          "code": "JL-01",
          "name": "Job Level 1",
          "effectiveDate": "2021-01-31",
          "endDate": "9999-12-31",
          "jobPosition": {
            "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
            "code": "JP-001",
            "name": "Job Position Name"
          },
          "level": 1
        },
        "maxJobLevel": {
          "id": "1211c096-4c06-4cce-8bf3-c6060a46ac34",
          "code": "JL-07",
          "name": "Job Level 7",
          "effectiveDate": "2021-01-31",
          "endDate": "9999-12-31",
          "jobPosition": {
            "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
            "code": "JP-007",
            "name": "Job Position Name"
          },
          "level": 6
        }
      },
      "jobLevel": {
        "id": "944e67fc-3ac4-463d-9854-db536f4dad56",
        "code": "JL-020",
        "name": "Staff",
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31",
        "jobPosition": {
          "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
          "code": "JP-001",
          "name": "Job Position Name"
        },
        "level": 1
      },
      "location": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb9",
        "code": "LOC-001",
        "name": "Location Name",
        "locationGroup": {
          "id": "81d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "LG-001",
          "name": "Location Group Name"
        },
        "city": {
          "id": "31d5f69a-a5a4-1111-80f5-76304dec7eb2",
          "code": "31.70",
          "name": "Jakarta",
          "state": {
            "id": "51d5f69a-a5a4-1111-80f5-76304dec7eb3",
            "code": "35",
            "name": "East Java",
            "country": {
              "id": "11d5f69a-a5a4-1111-80f5-76304dec7eb1",
              "code": "IDN",
              "name": "Indonesia"
            }
          }
        },
        "address": "Menara Citicon, 17th Floor, Jl. Letjen. S. Parman Kav 72",
        "phone": "[phone]",
        "zipCode": "11410",
        "headquarter": true,
        "latitude": -6.174465,
        "longitude": 106.827153,
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "COMP-001",
          "name": "PT. CATAPA"
        },
        "effectiveDate": "2023-01-01",
        "endDate": "9999-12-31"
      },
      "costCenter": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb2",
        "code": "CC-002",
        "name": "Cost Center Name 2",
        "description": "Cost Center Description 2",
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "COMP-001",
          "name": "PT. CATAPA"
        }
      },
      "employmentType": {
        "id": "a896cc20-aba9-11e6-80f6-76304dec7eb7",
        "name": "Permanent",
        "employmentGroupCode": "EGC-001",
        "permanent": false,
        "monthDuration": 8,
        "effectiveDate": "2021-01-31",
        "endDate": "9999-12-31"
      },
      "employmentStatusType": {
        "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb3",
        "name": "Permanent",
        "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
        "defaultData": false
      },
      "contractStart": "2021-01-31",
      "contractEnd": "2023-01-31",
      "signDate": "2021-01-31",
      "effectiveDate": "2021-01-31",
      "endDate": "2022-01-31",
      "permanentDate": "2021-01-31",
      "subLocation": {
        "id": "81d5f69a-a5a4-1111-80f5-76304dec7db8",
        "code": "SL-001",
        "name": "Sub Location Name",
        "location": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7ej2",
          "code": "LOC-005",
          "name": "Location Name",
          "company": {
            "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
            "code": "COMP-001",
            "name": "PT. CATAPA"
          },
          "effectiveDate": "2022-01-01",
          "endDate": "9999-12-31"
        },
        "effectiveDate": "2022-01-01",
        "endDate": "9999-12-31"
      },
      "operationalGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb2",
        "code": "OG-001",
        "name": "Operational Group Name"
      },
      "position": {
        "id": "31d5f69a-a5a4-1111-80f5-76304dec7eb3",
        "code": "POS-001",
        "name": "Position Name",
        "effectiveDate": "2021-01-31",
        "endDate": "1970-01-01"
      },
      "employee": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "identificationNumber": "EMP-001"
      }
    }
  ],
  "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
}

Deprecated

Get Employment Status by Employee

get

⚠️ This endpoint is deprecated. Please use Get Employment Statuses instead.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

Query parameters

querystringOptional

Search query

Supported Keys	Supported Operators	Notes
effectiveDate	> <	Greater than or equal operator Less than or equal operator Use the YYYY-MM-DD format, e.g. effectiveDate>2023-09-20

Example: {"summary":"Search by Effective Date","value":"effectiveDate>2023-09-20"}

Responses

200

OK

application/json

idstringOptional

contractStartstring · dateOptional

YYYY-MM-DD

contractEndstring · dateOptional

YYYY-MM-DD

effectiveDatestring · dateOptional

YYYY-MM-DD

employmentStatusNumberstringOptional

permanentDatestring · dateOptional

YYYY-MM-DD

signDatestring · dateOptional

YYYY-MM-DD

400

Bad Request

get

/core/v1/employees/{employeeId}/employment-data

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/employment-data?query=effectiveDate%3E2023-09-20" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "5540d712-508c-4831-84a6-8433933409d6",
  "employmentStatusNumber": "PKWT-UPDATE-SUCCESS",
  "position": {
    "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
    "code": "JP-001",
    "name": "Software Engineer",
    "effectiveDate": "2021-01-31",
    "endDate": "1970-01-01",
    "createdBy": "system",
    "createdDate": 1727370164151,
    "updatedBy": "system",
    "updatedDate": 1727370164151
  },
  "organization": {
    "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb7",
    "code": "ORG-002",
    "name": "ICT",
    "type": "FUNCTIONAL",
    "company": {
      "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb6",
      "code": "COMP-001",
      "name": "PT ABC"
    },
    "organizationHierarchy": {
      "id": "a896d062-aba9-11e6-80f5-76304dec7eb7",
      "code": "ORG-002",
      "name": "Departemen ICT",
      "color": "#B7783A",
      "level": 2
    },
    "organizationGroup": {
      "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
      "code": "OG-001",
      "name": "Organization Group"
    },
    "organizationParent": {}
  },
  "jobTitle": {
    "id": "3fb954ed-f00d-4f6f-b9ee-35f3ef817df9",
    "code": "JT010",
    "name": "Staff",
    "effectiveDate": "2021-01-31",
    "endDate": "9999-12-31",
    "minJobLevel": {
      "id": "4211c096-4c06-4cce-8bf3-c6060a46ac34",
      "code": "JL-01",
      "name": "Job Level 1",
      "effectiveDate": "2021-01-31",
      "endDate": "9999-12-31",
      "jobPosition": {
        "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
        "code": "JP-001",
        "name": "Job Position Name"
      },
      "level": 1
    },
    "maxJobLevel": {
      "id": "1211c096-4c06-4cce-8bf3-c6060a46ac34",
      "code": "JL-07",
      "name": "Job Level 7",
      "effectiveDate": "2021-01-31",
      "endDate": "9999-12-31",
      "jobPosition": {
        "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
        "code": "JP-007",
        "name": "Job Position Name"
      },
      "level": 6
    }
  },
  "jobLevel": {
    "id": "944e67fc-3ac4-463d-9854-db536f4dad56",
    "code": "JL-020",
    "name": "Staff",
    "effectiveDate": "2021-01-31",
    "endDate": "9999-12-31",
    "jobPosition": {
      "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
      "code": "JP-001",
      "name": "Job Position Name"
    },
    "level": 1
  },
  "location": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb9",
    "code": "LOC-001",
    "name": "Location Name",
    "locationGroup": {
      "id": "81d5f69a-a5a4-1111-80f5-76304dec7eb7",
      "code": "LG-001",
      "name": "Location Group Name"
    },
    "city": {
      "id": "31d5f69a-a5a4-1111-80f5-76304dec7eb2",
      "code": "31.70",
      "name": "Jakarta",
      "state": {
        "id": "51d5f69a-a5a4-1111-80f5-76304dec7eb3",
        "code": "35",
        "name": "East Java",
        "country": {
          "id": "11d5f69a-a5a4-1111-80f5-76304dec7eb1",
          "code": "IDN",
          "name": "Indonesia"
        }
      }
    },
    "address": "Menara Citicon, 17th Floor, Jl. Letjen. S. Parman Kav 72",
    "phone": "[phone]",
    "zipCode": "11410",
    "headquarter": true,
    "latitude": -6.174465,
    "longitude": 106.827153,
    "effectiveDate": "2023-01-01",
    "endDate": "9999-12-31"
  },
  "costCenter": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb1",
    "code": "CC-001",
    "name": "Cost Center Name",
    "description": "Cost Center Description"
  },
  "employmentType": {
    "id": "a896cc20-aba9-11e6-80f6-76304dec7eb7",
    "name": "Permanent",
    "employmentGroupCode": "EGC-001",
    "permanent": false,
    "monthDuration": 8,
    "effectiveDate": "2021-01-31",
    "endDate": "9999-12-31"
  },
  "employmentStatusType": {
    "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb3",
    "name": "Permanent",
    "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
    "defaultData": false
  },
  "contractStart": "2021-01-31",
  "contractEnd": "2023-01-31",
  "signDate": "2021-01-31",
  "effectiveDate": "2021-01-31",
  "permanentDate": "2021-01-31",
  "subLocation": {
    "id": "81d5f69a-a5a4-1111-80f5-76304dec7db8",
    "code": "SL-001",
    "name": "Sub Location Name",
    "location": {
      "id": "61d5f69a-a5a4-1111-80f5-76304dec7ej2",
      "code": "LOC-005",
      "name": "Location Name",
      "effectiveDate": "2022-01-01",
      "endDate": "9999-12-31"
    },
    "effectiveDate": "2022-01-01",
    "endDate": "9999-12-31"
  },
  "operationalGroup": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb2",
    "code": "OG-001",
    "name": "Operational Group Name"
  }
}

Update Employment Status by Employee

put

Generate Employment Status Number

The default value for the generateEmploymentStatusNumber field in the request body is set to false. If a request is sent with the value of true, it will first check the existing employee policy. If the employee policy is set to manual, it will accept the employment status number in the request. If the employee policy is set to automatic, it will generate a new employment status number based on the format in the employee policy.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

Body

application/json

contractStartstring · dateOptional

YYYY-MM-DD

contractEndstring · dateOptional

YYYY-MM-DD

effectiveDatestring · dateRequired

YYYY-MM-DD

employmentStatusNumberstring · max: 255Required

employmentStatusTypeIdstringRequired

employmentTypeIdstringRequired

jobLevelIdstringRequired

jobTitleIdstringRequired

locationIdstringRequired

organizationIdstringRequired

costCenterIdstringOptional

permanentDatestring · dateOptional

YYYY-MM-DD

signDatestring · dateRequired

YYYY-MM-DD

generateEmploymentStatusNumberbooleanOptionalDefault: false

subLocationIdstringOptional

operationalGroupIdstringOptional

Responses

200

OK

application/json

idstringOptional

contractStartstring · dateOptional

YYYY-MM-DD

contractEndstring · dateOptional

YYYY-MM-DD

effectiveDatestring · dateOptional

YYYY-MM-DD

employmentStatusNumberstringOptional

permanentDatestring · dateOptional

YYYY-MM-DD

signDatestring · dateOptional

YYYY-MM-DD

400

Bad Request

put

/core/v1/employees/{employeeId}/employment-data

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/employment-data" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '...'

{
  "id": "5540d712-508c-4831-84a6-8433933409d6",
  "employmentStatusNumber": "PKWT-UPDATE-SUCCESS",
  "organization": {
    "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb7",
    "code": "ORG-002",
    "name": "ICT",
    "type": "FUNCTIONAL",
    "company": {
      "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb6",
      "code": "COMP-001",
      "name": "PT ABC"
    },
    "organizationHierarchy": {
      "id": "a896d062-aba9-11e6-80f5-76304dec7eb7",
      "code": "ORG-002",
      "name": "Departemen ICT",
      "color": "#B7783A",
      "level": 2
    },
    "organizationGroup": {
      "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
      "code": "OG-001",
      "name": "Organization Group"
    },
    "organizationParent": {}
  },
  "jobTitle": {
    "id": "3fb954ed-f00d-4f6f-b9ee-35f3ef817df9",
    "code": "JT010",
    "name": "Staff",
    "effectiveDate": "2021-01-31",
    "endDate": "9999-12-31",
    "minJobLevel": {
      "id": "4211c096-4c06-4cce-8bf3-c6060a46ac34",
      "code": "JL-01",
      "name": "Job Level 1",
      "effectiveDate": "2021-01-31",
      "endDate": "9999-12-31",
      "jobPosition": {
        "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
        "code": "JP-001",
        "name": "Job Position Name"
      },
      "level": 1
    },
    "maxJobLevel": {
      "id": "1211c096-4c06-4cce-8bf3-c6060a46ac34",
      "code": "JL-07",
      "name": "Job Level 7",
      "effectiveDate": "2021-01-31",
      "endDate": "9999-12-31",
      "jobPosition": {
        "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
        "code": "JP-007",
        "name": "Job Position Name"
      },
      "level": 6
    }
  },
  "jobLevel": {
    "id": "944e67fc-3ac4-463d-9854-db536f4dad56",
    "code": "JL-020",
    "name": "Staff",
    "effectiveDate": "2021-01-31",
    "endDate": "9999-12-31",
    "jobPosition": {
      "id": "2a1666cc-d7e8-11e6-bf26-cec0c932ce01",
      "code": "JP-001",
      "name": "Job Position Name"
    },
    "level": 1
  },
  "location": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb9",
    "code": "LOC-001",
    "name": "Location Name",
    "locationGroup": {
      "id": "81d5f69a-a5a4-1111-80f5-76304dec7eb7",
      "code": "LG-001",
      "name": "Location Group Name"
    },
    "city": {
      "id": "31d5f69a-a5a4-1111-80f5-76304dec7eb2",
      "code": "31.70",
      "name": "Jakarta",
      "state": {
        "id": "51d5f69a-a5a4-1111-80f5-76304dec7eb3",
        "code": "35",
        "name": "East Java",
        "country": {
          "id": "11d5f69a-a5a4-1111-80f5-76304dec7eb1",
          "code": "IDN",
          "name": "Indonesia"
        }
      }
    },
    "address": "Menara Citicon, 17th Floor, Jl. Letjen. S. Parman Kav 72",
    "phone": "[phone]",
    "zipCode": "11410",
    "headquarter": true,
    "latitude": -6.174465,
    "longitude": 106.827153,
    "effectiveDate": "2023-01-01",
    "endDate": "9999-12-31"
  },
  "costCenter": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb1",
    "code": "CC-001",
    "name": "Cost Center Name",
    "description": "Cost Center Description"
  },
  "employmentType": {
    "id": "a896cc20-aba9-11e6-80f6-76304dec7eb7",
    "name": "Permanent",
    "employmentGroupCode": "EGC-001",
    "permanent": false,
    "monthDuration": 8,
    "effectiveDate": "2021-01-31",
    "endDate": "9999-12-31"
  },
  "employmentStatusType": {
    "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb3",
    "name": "Permanent",
    "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
    "defaultData": false
  },
  "contractStart": "2021-01-31",
  "contractEnd": "2023-01-31",
  "signDate": "2021-01-31",
  "effectiveDate": "2021-01-31",
  "permanentDate": "2021-01-31",
  "subLocation": {
    "id": "81d5f69a-a5a4-1111-80f5-76304dec7db8",
    "code": "SL-001",
    "name": "Sub Location Name",
    "location": {
      "id": "61d5f69a-a5a4-1111-80f5-76304dec7ej2",
      "code": "LOC-005",
      "name": "Location Name",
      "effectiveDate": "2022-01-01",
      "endDate": "9999-12-31"
    },
    "effectiveDate": "2022-01-01",
    "endDate": "9999-12-31"
  },
  "operationalGroup": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb2",
    "code": "OG-001",
    "name": "Operational Group Name"
  }
}