Master Data

These endpoints let you manage master data in the system. It allows you to retrieve, create, update, and delete master data records.

Get Banks

get

Return the banks.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/banks

curl -X GET \
  "https://api.catapa.com/core/v1/banks" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "code": "014",
      "name": "BANK BCA",
      "llg": "140397"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Bank Branches

get

Search Query

Supported Keys

Supported Operators

Notes

:

Equal operator Support multiple values with each value separated by the ; delimiter

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/bank-branches

curl -X GET \
  "https://api.catapa.com/core/v1/bank-branches" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
      "code": "BCA01",
      "name": "BCA Wisma Asia",
      "address": "Wisma Asia",
      "bank": {
        "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
        "code": "014",
        "name": "BCA",
        "llg": "146789"
      }
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Cities

get

Return the cities.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/cities

curl -X GET \
  "https://api.catapa.com/core/v1/cities" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "fffef432-9d5f-4c41-b20f-2a2eb3ac6f9c",
      "code": "91.17",
      "name": "Kab. Mappi",
      "state": {
        "id": "71f5c140-a699-11e6-80f5-76304dec7eb7",
        "name": "Papua",
        "code": "91",
        "country": {
          "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
          "code": "IDN",
          "callingCode": "+62",
          "name": "Indonesia",
          "taxTreaty": false
        }
      }
    }
  ],
  "totalPages": 1,
  "last": false,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 1,
  "number": 0
}

Create City

post

Create a city.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

namestring · min: 1 · max: 255Required

Responses

201

application/json

400

Bad Request

post

/core/v1/cities

curl -X POST \
  "https://api.catapa.com/core/v1/cities" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "91.17",
  "name": "Kab. Mappi",
  "state": {
    "id": "71f5c140-a699-11e6-80f5-76304dec7eb7"
  }
}'

{
  "id": "fffef432-9d5f-4c41-b20f-2a2eb3ac6f9c",
  "code": "91.17",
  "name": "Kab. Mappi",
  "state": {
    "id": "71f5c140-a699-11e6-80f5-76304dec7eb7",
    "name": "Papua",
    "code": "91",
    "country": {
      "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
      "code": "IDN",
      "callingCode": "+62",
      "name": "Indonesia",
      "taxTreaty": false
    }
  }
}

Get States

get

Return the states.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/states

curl -X GET \
  "https://api.catapa.com/core/v1/states" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "71f5c140-a699-11e6-80f5-76304dec7eb7",
      "name": "Papua",
      "code": "91",
      "description": "Province in eastern Indonesia",
      "country": {
        "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
        "name": "Indonesia",
        "code": "IDN"
      }
    }
  ],
  "totalPages": 1,
  "last": false,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 1,
  "number": 0
}

Get Countries

get

Return the countries.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/countries

curl -X GET \
  "https://api.catapa.com/core/v1/countries" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "d1eb9334-a691-11e6-80f5-76304dec7eb7",
      "code": "ZWE",
      "callingCode": "+263",
      "name": "Zimbabwe",
      "taxTreaty": false
    }
  ],
  "totalPages": 1,
  "last": false,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 1,
  "number": 0
}

Create Country

post

Create a country.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

callingCodestring · min: 1 · max: 5Required

e.g. +62

Pattern: ^\+\d{1,5}$

namestring · min: 1 · max: 255Required

taxTreatybooleanOptionalDefault: false

Responses

201

application/json

400

Bad Request

post

/core/v1/countries

curl -X POST \
  "https://api.catapa.com/core/v1/countries" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "IDN",
  "callingCode": "+62",
  "name": "Indonesia",
  "taxTreaty": true
}'

{
  "id": "d1eb9334-a691-11e6-80f5-76304dec7eb7",
  "code": "ZWE",
  "callingCode": "+263",
  "name": "Zimbabwe",
  "taxTreaty": false
}

Get Currencies

get

Return the currencies.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/currencies

curl -X GET \
  "https://api.catapa.com/core/v1/currencies" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "d1ea18d8-a691-11e6-80f5-76304dec7179",
      "code": "ZWL",
      "name": "Zimbabwean Dollar A/10",
      "baseCurrency": false
    }
  ],
  "totalPages": 1,
  "last": false,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 1,
  "number": 0
}

Get Historical Educations

get

Return the historical educations.

Authorizations

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 with multiple values. Each value should separated with delimiters `;`
employee.id	`:`	Equal operator with multiple values. Each value should separated with delimiters `;`

Example:

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

Responses

200

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/educations

curl -X GET \
  "https://api.catapa.com/core/v1/educations?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": "e28f5618-bc6c-11e6-80f5-76304dec7eb1",
      "educationLevel": {
        "id": "17ddbb6c-c74e-46ca-b828-45099db71670",
        "name": "Bachelor Degree",
        "code": "BACHELOR"
      },
      "fieldOfStudy": {
        "id": "dc5c5267-686b-4050-8f10-3f5c3c7d6aba",
        "name": "Computer Science",
        "code": "COMPSC"
      },
      "country": {
        "id": "4f09406b-a143-428a-8b93-855483f4de80",
        "name": "Indonesia",
        "code": "IDN"
      },
      "institution": {
        "id": "6248cd57-68cd-48a9-af19-5ebdecd59482",
        "name": "University of Indonesia",
        "code": "UI"
      },
      "startDate": "2015-09-17",
      "graduationDate": "2019-06-30",
      "createdBy": "system",
      "createdDate": 1745996853000,
      "updatedBy": "system",
      "updatedDate": 1745996853000
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "startDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Education Levels

get

Return the education levels.

Authorizations

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 with multiple values. Each value should separated with delimiters `;`

Example:

{"summary":"Search education levels by multiple IDs","value":"id:e18f5618-bc6c-11e6-80f5-76304dec7eb1;f38f5618-bc6c-11e6-80f5-76304dec7ec6"}

Responses

200

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/education-levels

curl -X GET \
  "https://api.catapa.com/core/v1/education-levels?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": "e18f5618-bc6c-11e6-80f5-76304dec7eb1",
      "name": "Sekolah Dasar",
      "code": "EDLV4"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Employment Status Types

get

Search Query

Supported Keys

Supported Operators

Notes

name

:

Like operator

employmentStatusNumberType

:

Like operator

defaultData

:

Equal operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

namestringOptionalExample: Active

employmentStatusNumberTypestringOptionalExample: PKWT_NUMBER

defaultDatastringOptionalExample: false

Responses

200

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-types

curl -X GET \
  "https://api.catapa.com/core/v1/employment-status-types?name=Active&employmentStatusNumberType=PKWT_NUMBER&defaultData=false" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb8",
      "name": "Rollover Contract",
      "employmentStatusNumberType": "PKWT_NUMBER",
      "defaultData": false
    },
    {
      "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb7",
      "name": "Rotation",
      "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
      "defaultData": false
    },
    {
      "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb6",
      "name": "Demotion",
      "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
      "defaultData": false
    },
    {
      "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb5",
      "name": "Mutation",
      "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
      "defaultData": false
    },
    {
      "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb4",
      "name": "Promotion",
      "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
      "defaultData": false
    },
    {
      "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb3",
      "name": "Permanent",
      "employmentStatusNumberType": "EMPLOYMENT_STATUS_CHANGE_NUMBER",
      "defaultData": false
    },
    {
      "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb2",
      "name": "Rehire",
      "employmentStatusNumberType": "PKWT_NUMBER",
      "defaultData": false
    },
    {
      "id": "f18f5618-ac6c-11e6-80f5-76304dec7eb1",
      "name": "Recruit",
      "employmentStatusNumberType": "PKWT_NUMBER",
      "defaultData": true
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 8,
  "numberOfElements": 8,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Employment Types

get

Search Query

Supported Keys

Supported Operators

Notes

name

:

Like operator

employmentGroupCode

:

Like operator

permanent

:

Equal operator

otherLeaveStatus.code

:

Equal operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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-types

curl -X GET \
  "https://api.catapa.com/core/v1/employment-types" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "a896cc20-aba9-11e6-80f9-76304dec7eb7",
      "name": "Outsourcing",
      "employmentGroupCode": "004",
      "monthDuration": 1,
      "permanent": false,
      "effectiveDate": "2024-01-01",
      "endDate": "9999-12-31"
    },
    {
      "id": "a896cc20-aba9-11e6-80f8-76304dec7eb7",
      "name": "Contract - 12 months",
      "employmentGroupCode": "003",
      "monthDuration": 12,
      "permanent": false,
      "effectiveDate": "2024-01-01",
      "endDate": "2024-12-31"
    },
    {
      "id": "a896cc20-aba9-11e6-80f7-76304dec7eb7",
      "name": "Contract - 6 months",
      "employmentGroupCode": "002",
      "monthDuration": 6,
      "permanent": false,
      "effectiveDate": "2024-01-01",
      "endDate": "9999-12-31"
    },
    {
      "id": "a896cc20-aba9-11e6-80f6-76304dec7eb7",
      "name": "Permanent",
      "employmentGroupCode": "001",
      "monthDuration": 0,
      "permanent": true,
      "effectiveDate": "2024-01-01",
      "endDate": "2024-12-31"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 4,
  "numberOfElements": 4,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Create Employment Type

post

Create an employment type.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 255Required

employmentGroupCodestring · min: 1 · max: 3RequiredPattern: [a-zA-Z0-9]+

monthDurationinteger · max: 60Required

permanentbooleanOptionalDefault: false

effectiveDatestring · dateRequired

Effective date for the employment type. Defaults to minimum date if not provided.

endDatestring · dateOptional

End date for the employment type

Responses

201

application/json

400

Bad Request

post

/core/v1/employment-types

curl -X POST \
  "https://api.catapa.com/core/v1/employment-types" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "NEW",
  "employmentGroupCode": "008",
  "monthDuration": 6,
  "permanent": false,
  "effectiveDate": "2024-01-01",
  "endDate": "9999-12-31"
}'

{
  "id": "2ee5526d-fe72-4a25-8280-223c785701dc",
  "name": "NEW",
  "employmentGroupCode": "008",
  "monthDuration": 6,
  "permanent": false,
  "effectiveDate": "2024-01-01",
  "endDate": "9999-12-31"
}

Update Employment Type

put

Update the employment type.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Body

namestring · min: 1 · max: 255Required

employmentGroupCodestring · min: 1 · max: 3RequiredPattern: [a-zA-Z0-9]+

monthDurationinteger · max: 60Required

permanentbooleanOptionalDefault: false

effectiveDatestring · dateRequired

Effective date for the employment type. Defaults to minimum date if not provided.

endDatestring · dateOptional

End date for the employment type

Responses

200

application/json

idstringOptional

namestringOptional

employmentGroupCodestringOptional

monthDurationintegerOptional

permanentbooleanOptional

effectiveDatestring · dateOptional

endDatestring · dateOptional

400

Bad Request

put

/core/v1/employment-types/{id}

curl -X PUT \
  "https://api.catapa.com/core/v1/employment-types/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "NEW",
  "employmentGroupCode": "008",
  "monthDuration": 6,
  "permanent": false,
  "effectiveDate": "2024-01-01",
  "endDate": "9999-12-31"
}'

{
  "id": "2ee5526d-fe72-4a25-8280-223c785701dc",
  "name": "NEW",
  "employmentGroupCode": "008",
  "monthDuration": 6,
  "permanent": false,
  "effectiveDate": "2024-01-01",
  "endDate": "9999-12-31"
}

Get Family Relations

get

Search Query

Supported Keys

Supported Operators

Notes

name

:

Like operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/family-relations

curl -X GET \
  "https://api.catapa.com/core/v1/family-relations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "990e865e-b612-4876-838b-6924a11797d8",
      "name": "Anak Kesepuluh",
      "code": "Anak Kesepuluh",
      "relationType": "OTHER_CHILD"
    },
    {
      "id": "5f9338ad-f872-4f2f-bf15-07227afeed31",
      "name": "Anak Kesembilan",
      "code": "Anak Kesembilan",
      "relationType": "OTHER_CHILD"
    },
    {
      "id": "8217b1e1-08b4-4767-8701-df60ba50f3b4",
      "name": "Anak Kedelapan",
      "code": "Anak Kedelapan",
      "relationType": "OTHER_CHILD"
    },
    {
      "id": "e17479f6-a3b3-4440-b13a-e162800db5a8",
      "name": "Anak Ketujuh",
      "code": "Anak Ketujuh",
      "relationType": "OTHER_CHILD"
    },
    {
      "id": "badf4b70-9d5c-460f-a00f-2180a7db1f80",
      "name": "Anak Keenam",
      "code": "Anak Keenam",
      "relationType": "OTHER_CHILD"
    },
    {
      "id": "1f29f8ea-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Anak Kelima",
      "code": "Anak Kelima",
      "relationType": "OTHER_CHILD"
    },
    {
      "id": "1f29f624-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Anak Keempat",
      "code": "Anak Keempat",
      "relationType": "OTHER_CHILD"
    },
    {
      "id": "1f29f476-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Anak Ketiga",
      "code": "Anak Ketiga",
      "relationType": "THIRD_CHILD"
    },
    {
      "id": "1f29f1b0-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Anak Kedua",
      "code": "Anak Kedua",
      "relationType": "SECOND_CHILD"
    },
    {
      "id": "1f29efe4-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Anak Pertama",
      "code": "Anak Pertama",
      "relationType": "FIRST_CHILD"
    },
    {
      "id": "1f29ecd8-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Suami / Istri",
      "code": "Suami / Istri",
      "relationType": "SPOUSE"
    },
    {
      "id": "1f29ea4e-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Ibu Kandung",
      "code": "Ibu Kandung",
      "relationType": "MOTHER"
    },
    {
      "id": "1f29e7ec-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Ayah Kandung",
      "code": "Ayah Kandung",
      "relationType": "FATHER"
    },
    {
      "id": "1f29e486-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Kontak Darurat",
      "code": "Kontak Darurat",
      "relationType": "OTHER"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 14,
  "numberOfElements": 14,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 20,
  "number": 0
}

Get Field Of Study

get

Return the field of studies.

Authorizations

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 with multiple values. Each value should separated with delimiters `;`

Example:

{"summary":"Search Field Of Studies by Multiple IDs","value":"id:e18f5618-bc6c-11e6-80f5-76304dec7eb1;295b44b6-f435-11e6-bc64-92361f002671"}

Responses

200

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/field-of-studies

curl -X GET \
  "https://api.catapa.com/core/v1/field-of-studies?page=0&size=10&query=id%3Ae18f5618-bc6c-11e6-80f5-76304dec7eb1%3B295b44b6-f435-11e6-bc64-92361f002671" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "61d5ff6e-a5a4-11e6-80f5-76304dec7eb8",
      "name": "Computer Science",
      "code": "COMPSC"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Identity Card

get

Search Query

Supported Keys

Supported Operators

Notes

name

:

Like operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/identity-cards

curl -X GET \
  "https://api.catapa.com/core/v1/identity-cards" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "73dabc7c-a7da-11e6-80f5-76304dec7eb7",
      "code": "SIMC",
      "name": "SIM C",
      "identityCardType": "OTHER"
    },
    {
      "id": "73daac7c-a7da-11e6-80f5-76304dec7eb7",
      "code": "SIMA",
      "name": "SIM A",
      "identityCardType": "OTHER"
    },
    {
      "id": "73da9d40-a7da-11e6-80f5-76304dec7eb7",
      "code": "PASSP",
      "name": "PASSPORT",
      "identityCardType": "PASSPORT"
    },
    {
      "id": "73da99da-a7da-11e6-80f5-76304dec7eb7",
      "code": "KTP",
      "name": "KTP",
      "identityCardType": "KTP"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 4,
  "numberOfElements": 4,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Institutions

get

Return the institutions.

Authorizations

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 with multiple values. Each value should separated with delimiters `;`

Example:

{"summary":"Search Institutions by Multiple IDs","value":"id:e18f5618-bc6c-11e6-80f5-76304dec7eb1;37364434-f4c9-11e6-bc64-92361f002671"}

Responses

200

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/institutions

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

{
  "content": [
    {
      "id": "e18f5618-bc6c-11e6-80f5-76304dec7eb1",
      "name": "University of Indonesia",
      "code": "UI"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Religions

get

Return the religions.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

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/religions

curl -X GET \
  "https://api.catapa.com/core/v1/religions" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "daa7f10k-a734-11e6-80f5-76304dec7eb7",
      "name": "Others",
      "code": "Others"
    },
    {
      "id": "daa7f10j-a734-11e6-80f5-76304dec7eb7",
      "name": "Protestantism",
      "code": "Protestantism"
    },
    {
      "id": "daa7f10i-a734-11e6-80f5-76304dec7eb7",
      "name": "Confucianism",
      "code": "Confucianism"
    },
    {
      "id": "daa7f10h-a734-11e6-80f5-76304dec7eb7",
      "name": "Islam",
      "code": "Islam"
    },
    {
      "id": "daa7f10g-a734-11e6-80f5-76304dec7eb7",
      "name": "Hinduism",
      "code": "Hinduism"
    },
    {
      "id": "daa7f10f-a734-11e6-80f5-76304dec7eb7",
      "name": "Catholicism",
      "code": "Catholicism"
    },
    {
      "id": "daa7f10e-a734-11e6-80f5-76304dec7eb7",
      "name": "Buddhism",
      "code": "Buddhism"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 7,
  "numberOfElements": 7,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Create Religion

post

Create a religion.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 255Required

codestring · max: 255Optional

Responses

201

application/json

400

Bad Request

post

/core/v1/religions

curl -X POST \
  "https://api.catapa.com/core/v1/religions" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Others",
  "code": "Others"
}'

{
  "id": "daa7f10k-a734-11e6-80f5-76304dec7eb7",
  "name": "Others",
  "code": "Others"
}

Last updated 16 days ago

hashtagGet Banks

hashtagGet Bank Branches

hashtagSearch Query

hashtagGet Cities

hashtagCreate City

hashtagGet States

hashtagGet Countries

hashtagCreate Country

hashtagGet Currencies

hashtagGet Historical Educations

Search Query

hashtagGet Education Levels

Search Query

hashtagGet Employment Status Types

hashtagSearch Query

hashtagGet Employment Types

hashtagSearch Query

hashtagCreate Employment Type

hashtagUpdate Employment Type

hashtagGet Family Relations

hashtagSearch Query

hashtagGet Field Of Study

Search Query

hashtagGet Identity Card

hashtagSearch Query

hashtagGet Institutions

Search Query

hashtagGet Religions

hashtagCreate Religion

Get Banks

Get Bank Branches

Search Query

Get Cities

Create City

Get States

Get Countries

Create Country

Get Currencies

Get Historical Educations

Get Education Levels

Get Employment Status Types

Search Query

Get Employment Types

Search Query

Create Employment Type

Update Employment Type

Get Family Relations

Search Query

Get Field Of Study

Get Identity Card

Search Query

Get Institutions

Get Religions

Create Religion