Families

These endpoints let you manage family information for employees in the system. It allows you to retrieve, create, update, and delete family records.

Get Families

get

Return the family approvals.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

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/employees/{employeeId}/families/approvals

cURLPython SDK

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

{
  "content": [
    {
      "id": "ffe7cddf-9122-4605-af28-3b5af6e74b58",
      "name": "titis",
      "gender": "MALE",
      "dateOfBirth": "2021-03-02",
      "identityCardNumber": "",
      "familyRelation": {
        "id": "1f29e486-a7e9-11e6-80f5-76304dec7eb7",
        "name": "Kontak Darurat",
        "code": "Kontak Darurat",
        "relationType": "OTHER"
      },
      "employee": {
        "id": "db473cf9-3993-43c0-98b4-c8ec39230b79",
        "identificationNumber": "ID-0001",
        "name": "Hanna Silitonga"
      },
      "placeOfBirth": {
        "id": "27c26b4a-23f5-4d57-9f2c-5883ef44136f",
        "code": "11.12",
        "name": "Kab. Aceh Barat Daya",
        "state": {
          "id": "71f58cac-a699-11e6-80f5-76304dec7eb7",
          "name": "Nangroe Aceh Darussalam",
          "code": "11",
          "country": {
            "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
            "name": "Indonesia",
            "code": "IDN"
          }
        }
      },
      "alive": true,
      "dateOfDeath": "2024-01-01",
      "maritalStatus": "SINGLE",
      "marriageDate": "2020-01-01",
      "religion": {
        "id": "1f29f46a-a7e9-11e6-80f5-76304dec7eb7",
        "code": "ISLAM",
        "name": "Islam"
      },
      "educationLevel": {
        "id": "1f29f47a-a7e9-11e6-80f5-76304dec7eb7",
        "code": "S1",
        "name": "S1"
      },
      "job": "Staff",
      "mobilePhone": "",
      "description": "",
      "family": {
        "id": "be51db56-1cfd-4f05-979d-d4efa7e419d9",
        "name": "titis",
        "gender": "MALE",
        "dateOfBirth": "2021-03-02",
        "identityCardNumber": "",
        "familyRelation": {
          "id": "1f29e486-a7e9-11e6-80f5-76304dec7eb7",
          "name": "Kontak Darurat",
          "code": "Kontak Darurat",
          "relationType": "OTHER"
        },
        "employee": {
          "id": "db473cf9-3993-43c0-98b4-c8ec39230b79",
          "identificationNumber": "ID-0001",
          "name": "Hanna Silitonga"
        },
        "placeOfBirth": {
          "id": "27c26b4a-23f5-4d57-9f2c-5883ef44136f",
          "code": "11.12",
          "name": "Kab. Aceh Barat Daya",
          "state": {
            "id": "71f58cac-a699-11e6-80f5-76304dec7eb7",
            "name": "Nangroe Aceh Darussalam",
            "code": "11",
            "country": {
              "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
              "name": "Indonesia",
              "code": "IDN"
            }
          }
        },
        "alive": true,
        "dateOfDeath": "2024-01-01",
        "maritalStatus": "SINGLE",
        "marriageDate": "2020-01-01",
        "religion": {
          "id": "1f29f46a-a7e9-11e6-80f5-76304dec7eb7",
          "code": "ISLAM",
          "name": "Islam"
        },
        "educationLevel": {
          "id": "1f29f47a-a7e9-11e6-80f5-76304dec7eb7",
          "code": "S1",
          "name": "S1"
        },
        "job": "Staff",
        "mobilePhone": "",
        "description": ""
      },
      "approvalStatus": "APPROVED",
      "rejectionReason": "Incomplete documentation"
    }
  ],
  "totalPages": 11,
  "last": false,
  "totalElements": 11,
  "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 Family By Employee

post

Create a family by employee.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

Body

application/json

namestring · min: 1 · max: 255Required

genderstring · enumRequiredPossible values:

dateOfBirthstring · dateOptional

YYYY-MM-DD

identityCardNumberstring · max: 255Optional

alivebooleanOptionalDefault: true

dateOfDeathstring · dateOptional

If left null and the individual is marked as not alive, the system will automatically set the date of death to the default value of December 31, 9999

maritalStatusstring · enumOptionalPossible values:

marriageDatestring · dateOptional

YYYY-MM-DD

jobstring · max: 255Optional

Alphanumeric with space, e.g. Software Engineer 1

Pattern: [a-zA-Z0-9 ]+

mobilePhonestring · max: 255Optional

e.g. [phone]

Pattern: ^[+]{1}[0-9-() ]+

descriptionstring · max: 65535Optional

Responses

201

OK

application/json

400

Bad Request

post

/core/v1/employees/{employeeId}/families/approvals

cURLPython SDK

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

{
  "id": "8ff4a4c7-2776-485f-b126-2ed8de04a6b0",
  "name": "John Doe",
  "gender": "MALE",
  "dateOfBirth": "2021-03-02",
  "identityCardNumber": "",
  "familyRelation": {
    "id": "1f29f1b0-a7e9-11e6-80f5-76304dec7eb7",
    "name": "Anak Kedua",
    "code": "Anak Kedua",
    "relationType": "SECOND_CHILD"
  },
  "employee": {
    "id": "0c639fb9-9a57-41a6-affb-fd7ef2e9f52c",
    "identificationNumber": "0004/EMP/01-2017",
    "name": "Rita Sarah"
  },
  "placeOfBirth": {
    "id": "27c26b4a-23f5-4d57-9f2c-5883ef44136f",
    "code": "11.12",
    "name": "Kab. Aceh Barat Daya"
  },
  "alive": true,
  "dateOfDeath": "2024-01-01",
  "maritalStatus": "SINGLE",
  "marriageDate": "2020-01-01",
  "religion": {
    "id": "1f29f46a-a7e9-11e6-80f5-76304dec7eb7",
    "name": "Islam"
  },
  "educationLevel": {
    "id": "1f29f47a-a7e9-11e6-80f5-76304dec7eb7",
    "name": "S1"
  },
  "job": "Staff",
  "mobilePhone": "[phone]",
  "description": "",
  "family": {
    "id": "be51db56-1cfd-4f05-979d-d4efa7e419d9",
    "name": "John Doe",
    "gender": "MALE",
    "dateOfBirth": "2021-03-02",
    "identityCardNumber": "",
    "familyRelation": {
      "id": "1f29e486-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Anak Kedua",
      "code": "Anak Kedua",
      "relationType": "SECOND_CHILD"
    },
    "employee": {
      "id": "0c639fb9-9a57-41a6-affb-fd7ef2e9f52c",
      "identificationNumber": "0004/EMP/01-2017",
      "name": "Rita Sarah"
    },
    "placeOfBirth": {
      "id": "27c26b4a-23f5-4d57-9f2c-5883ef44136f",
      "code": "11.12",
      "name": "Kab. Aceh Barat Daya"
    },
    "alive": true,
    "dateOfDeath": "2024-01-01",
    "maritalStatus": "SINGLE",
    "marriageDate": "2020-01-01",
    "religion": {
      "id": "1f29f46a-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Islam"
    },
    "educationLevel": {
      "id": "1f29f47a-a7e9-11e6-80f5-76304dec7eb7",
      "name": "S1"
    },
    "job": "Staff",
    "mobilePhone": "[phone]",
    "description": ""
  },
  "approvalStatus": "WAITING_FOR_APPROVAL",
  "rejectionReason": "Incomplete documentation"
}

Get Family

get

Return the family approval.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

approvalIdstringRequiredExample: a1b2c3d4-e5f6-7890-abcd-ef0123456789

Responses

200

OK

application/json

idstringOptional

namestringOptional

genderstring · enumOptionalPossible values:

dateOfBirthstringOptional

identityCardNumberstringOptional

alivebooleanOptional

dateOfDeathstringOptional

maritalStatusstring · enumOptionalPossible values:

marriageDatestringOptional

jobstringOptional

mobilePhonestringOptional

descriptionstringOptional

approvalStatusstring · enumOptionalPossible values:

rejectionReasonstringOptional

400

Bad Request

get

/core/v1/employees/{employeeId}/families/approvals/{approvalId}

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/families/approvals/a1b2c3d4-e5f6-7890-abcd-ef0123456789" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "ffe7cddf-9122-4605-af28-3b5af6e74b58",
  "name": "titis",
  "gender": "MALE",
  "dateOfBirth": "2021-03-02",
  "identityCardNumber": "",
  "familyRelation": {
    "id": "1f29e486-a7e9-11e6-80f5-76304dec7eb7",
    "name": "Kontak Darurat",
    "code": "Kontak Darurat",
    "relationType": "OTHER"
  },
  "employee": {
    "id": "db473cf9-3993-43c0-98b4-c8ec39230b79",
    "identificationNumber": "ID-0001",
    "name": "Hanna Silitonga"
  },
  "placeOfBirth": {
    "id": "27c26b4a-23f5-4d57-9f2c-5883ef44136f",
    "code": "11.12",
    "name": "Kab. Aceh Barat Daya",
    "state": {
      "id": "71f58cac-a699-11e6-80f5-76304dec7eb7",
      "name": "Nangroe Aceh Darussalam",
      "code": "11",
      "country": {
        "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
        "name": "Indonesia",
        "code": "IDN"
      }
    }
  },
  "alive": true,
  "dateOfDeath": "1970-01-01",
  "maritalStatus": "SINGLE",
  "marriageDate": "1970-01-01",
  "religion": {
    "id": "1f29f46a-a7e9-11e6-80f5-76304dec7eb7",
    "name": "Islam"
  },
  "educationLevel": {
    "id": "1f29f47a-a7e9-11e6-80f5-76304dec7eb7",
    "name": "S1"
  },
  "job": "Staff",
  "mobilePhone": "[phone]",
  "description": "",
  "family": {
    "id": "be51db56-1cfd-4f05-979d-d4efa7e419d9",
    "name": "titis",
    "gender": "MALE",
    "dateOfBirth": "2021-03-02",
    "identityCardNumber": "",
    "familyRelation": {
      "id": "1f29e486-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Kontak Darurat",
      "code": "Kontak Darurat",
      "relationType": "OTHER"
    },
    "employee": {
      "id": "db473cf9-3993-43c0-98b4-c8ec39230b79",
      "identificationNumber": "ID-0001",
      "name": "Hanna Silitonga"
    },
    "placeOfBirth": {
      "id": "27c26b4a-23f5-4d57-9f2c-5883ef44136f",
      "code": "11.12",
      "name": "Kab. Aceh Barat Daya",
      "state": {
        "id": "71f58cac-a699-11e6-80f5-76304dec7eb7",
        "name": "Nangroe Aceh Darussalam",
        "code": "11",
        "country": {
          "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
          "name": "Indonesia",
          "code": "IDN"
        }
      }
    },
    "alive": true,
    "dateOfDeath": "1970-01-01",
    "maritalStatus": "SINGLE",
    "marriageDate": "1970-01-01",
    "religion": {
      "id": "1f29f46a-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Islam"
    },
    "educationLevel": {
      "id": "1f29f47a-a7e9-11e6-80f5-76304dec7eb7",
      "name": "S1"
    },
    "job": "Staff",
    "mobilePhone": "[phone]",
    "description": ""
  },
  "approvalStatus": "APPROVED",
  "rejectionReason": ""
}

Update Family By Employee

put

Update the family by employee.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

approvalIdstringRequiredExample: a1b2c3d4-e5f6-7890-abcd-ef0123456789

Body

application/json

namestring · min: 1 · max: 255Required

genderstring · enumRequiredPossible values:

dateOfBirthstring · dateOptional

YYYY-MM-DD

identityCardNumberstring · max: 255Optional

alivebooleanOptionalDefault: true

dateOfDeathstring · dateOptional

If left null and the individual is marked as not alive, the system will automatically set the date of death to the default value of December 31, 9999

maritalStatusstring · enumOptionalPossible values:

marriageDatestring · dateOptional

YYYY-MM-DD

jobstring · max: 255Optional

Alphanumeric with space, e.g. Software Engineer 1

Pattern: [a-zA-Z0-9 ]+

mobilePhonestring · max: 255Optional

e.g. [phone]

Pattern: ^[+]{1}[0-9-() ]+

descriptionstring · max: 65535Optional

Responses

200

OK

application/json

idstringOptional

namestringOptional

genderstring · enumOptionalPossible values:

dateOfBirthstringOptional

identityCardNumberstringOptional

alivebooleanOptional

dateOfDeathstringOptional

maritalStatusstring · enumOptionalPossible values:

marriageDatestringOptional

jobstringOptional

mobilePhonestringOptional

descriptionstringOptional

approvalStatusstring · enumOptionalPossible values:

rejectionReasonstringOptional

400

Bad Request

put

/core/v1/employees/{employeeId}/families/approvals/{approvalId}

cURLPython SDK

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

{
  "id": "65cf489c-9f87-40fb-b28a-4967be2a62ff",
  "name": "M. Tetes Yes",
  "gender": "MALE",
  "dateOfBirth": "2021-03-02",
  "identityCardNumber": "",
  "familyRelation": {
    "id": "1f29f476-a7e9-11e6-80f5-76304dec7eb7",
    "name": "Anak Kedua",
    "code": "Anak Kedua",
    "relationType": "THIRD_CHILD"
  },
  "employee": {
    "id": "0c639fb9-9a57-41a6-affb-fd7ef2e9f52c",
    "identificationNumber": "0004/EMP/01-2017",
    "name": "Rita Sarah"
  },
  "placeOfBirth": {
    "id": "27c26b4a-23f5-4d57-9f2c-5883ef44136f",
    "code": "11.12",
    "name": "Kab. Aceh Barat Daya"
  },
  "alive": true,
  "dateOfDeath": "1970-01-01",
  "maritalStatus": "SINGLE",
  "marriageDate": "1970-01-01",
  "religion": {
    "id": "1f29f46a-a7e9-11e6-80f5-76304dec7eb7",
    "name": "Islam"
  },
  "educationLevel": {
    "id": "1f29f47a-a7e9-11e6-80f5-76304dec7eb7",
    "name": "S1"
  },
  "job": "Staff",
  "mobilePhone": "[phone]",
  "description": "",
  "family": {
    "id": "702d45ac-f838-4611-adf2-2fdb18d92156",
    "name": "tetes",
    "gender": "MALE",
    "dateOfBirth": "2021-03-02",
    "identityCardNumber": "",
    "familyRelation": {
      "id": "1f29f476-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Anak Ketiga",
      "code": "Anak Ketiga",
      "relationType": "THIRD_CHILD"
    },
    "employee": {
      "id": "0c639fb9-9a57-41a6-affb-fd7ef2e9f52c",
      "identificationNumber": "0004/EMP/01-2017",
      "name": "Rita Sarah"
    },
    "placeOfBirth": {
      "id": "27c26b4a-23f5-4d57-9f2c-5883ef44136f",
      "code": "11.12",
      "name": "Kab. Aceh Barat Daya"
    },
    "alive": true,
    "dateOfDeath": "1970-01-01",
    "maritalStatus": "SINGLE",
    "marriageDate": "1970-01-01",
    "religion": {
      "id": "1f29f46a-a7e9-11e6-80f5-76304dec7eb7",
      "name": "Islam"
    },
    "educationLevel": {
      "id": "1f29f47a-a7e9-11e6-80f5-76304dec7eb7",
      "name": "S1"
    },
    "job": "Staff",
    "mobilePhone": "[phone]",
    "description": ""
  },
  "approvalStatus": "WAITING_FOR_APPROVAL",
  "rejectionReason": ""
}

Get Families

get

Return the families.

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

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/families?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": "fff7cddf-9122-4605-af28-3b5af6e74b58",
      "name": "titis",
      "gender": "MALE",
      "dateOfBirth": "2021-03-31",
      "familyRelation": {
        "id": "1f29e486-a7e9-11e6-80f5-76304dec7eb7",
        "name": "Kontak Darurat",
        "code": "Kontak Darurat",
        "relationType": "OTHER"
      },
      "effectiveDate": "2017-05-15",
      "endDate": "1970-01-01",
      "createdBy": "system",
      "createdDate": 1653473735548,
      "updatedBy": "system",
      "updatedDate": 1653473735548
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "effectiveDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Approve Families

put

Approve the family approvals.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

idstringRequired

Unique identifier

Responses

200

OK

application/json

400

Bad Request

application/json

put

/core/v1/families/approvals/approve

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/families/approvals/approve" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": "7eb20b1e-577b-45c0-adf4-c76ae17cdeae"
  },
  {
    "id": "6a4d1903-b453-4694-9806-65101f0aec64"
  }
]'

{
  "successes": [
    {
      "id": "7eb20b1e-577b-45c0-adf4-c76ae17cdeae"
    },
    {
      "id": "6a4d1903-b453-4694-9806-65101f0aec64"
    }
  ],
  "failures": []
}

Reject Families

put

Reject the family approvals.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

application/json

idstringRequired

Approval ID

reasonstringRequired

Reason of Rejection

Responses

200

OK

application/json

400

Bad Request

application/json

put

/core/v1/families/approvals/reject

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/families/approvals/reject" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": "59a7fdc8-888c-437b-afec-44ffa490b160",
    "reason": "reason"
  },
  {
    "id": "032f6fd4-67d5-423f-9522-283f79391019",
    "reason": "reason"
  }
]'

{
  "successes": [
    {
      "id": "7eb20b1e-577b-45c0-adf4-c76ae17cdeae"
    },
    {
      "id": "6a4d1903-b453-4694-9806-65101f0aec64"
    }
  ],
  "failures": []
}

Delete Family

delete

Delete the family.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

familyIdstringRequiredExample: c3d4e5f6-a7b8-9012-cdef-01234567890b

Responses

200

OK

No content

404

Not Found

application/json

delete

/core/v1/employees/{employeeId}/families/{familyId}

cURLPython SDK

curl -X DELETE \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/families/c3d4e5f6-a7b8-9012-cdef-01234567890b" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

No content