Contact Information

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

Get Historical Contact Information

get

Return the historical contact information.

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 The contact information ID value is the same as the ID of the employee who owns this contact information
employee.id	:	Equal operator Support multiple values with each value separated by the ; delimiter The contact information ID value is the same as the ID of the employee who owns this contact information

Example: {"summary":"Search Contact Information by Multiple Contact Information or Employee IDs","value":"id:e18f5618-bc6c-11e6-80f5-76304dec7eb1;0100902f-5d8f-4de4-8fae-5ced86831dd1"}

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/contact-information

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/contact-information?page=0&size=10&query=id%3Ae18f5618-bc6c-11e6-80f5-76304dec7eb1%3B0100902f-5d8f-4de4-8fae-5ced86831dd1" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "c78d4a0f-9db1-47d0-b93e-960ea2d7b0ab",
      "mobilePhone": "+1231",
      "email": "[e-mail]",
      "workEmail": "[e-mail]",
      "personalEmail": "[e-mail]",
      "originalAddress": "10 Bayfront Ave",
      "originalAddressPhoneNumber": "+2231",
      "originalAddressDetail": {
        "address": "10 Bayfront Ave",
        "zipCode": "54321",
        "phone": "+2231",
        "district": "San Andreas",
        "city": {
          "id": "2d1e9f5a-a6ea-11e6-80f5-76304dec7eb7",
          "code": "NYC",
          "name": "New York City",
          "state": {
            "id": "71f59dbe-a699-11e6-80f5-76304dec7eb7",
            "code": "NY",
            "name": "New York",
            "country": {
              "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
              "code": "US",
              "name": "United States"
            }
          }
        }
      },
      "facebook": "www.facebook.com/johndoe",
      "linkedIn": "www.linkedin.com/in/johndoe",
      "effectiveDate": "2023-01-15",
      "createdBy": "system",
      "createdDate": 1481024187133,
      "updatedBy": "system",
      "updatedDate": 1481024187133,
      "residentialAddress": {
        "address": "123 Main Street",
        "zipCode": "12345",
        "phone": "[phone]",
        "district": "San Andreas",
        "city": {
          "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
          "code": "31.70",
          "name": "Jakarta",
          "state": {
            "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
            "code": "31",
            "name": "Jakarta Special Capital Region",
            "country": {
              "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
              "code": "IDN",
              "name": "Indonesia"
            }
          }
        }
      },
      "emergencyContact": {
        "name": "Emergency Contact",
        "relation": "Friend",
        "phone": "[phone]"
      },
      "employee": {
        "id": "e18f5618-bc6c-11e6-80f5-76304dec7eb1",
        "identificationNumber": "EMP12345",
        "name": "John Doe",
        "joinDate": "2022-08-15",
        "startDate": "2022-08-15",
        "active": true,
        "pointOfHire": {
          "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
          "code": "JKT-01",
          "name": "Jakarta Head Office",
          "locationGroup": {
            "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
            "code": "HQ",
            "name": "Headquarters"
          },
          "city": {
            "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
            "code": "31.70",
            "name": "Jakarta",
            "state": {
              "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
              "name": "Jakarta Special Capital Region",
              "code": "31",
              "country": {
                "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
                "code": "IDN",
                "callingCode": "62",
                "name": "Indonesia",
                "taxTreaty": true
              }
            }
          },
          "latitude": -6.2088,
          "longitude": 106.8456,
          "address": "Jl. Jenderal Sudirman Kav. 52-53",
          "phone": "[phone]",
          "zipCode": "12190",
          "headquarter": true,
          "company": {
            "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
            "code": "COMP-A",
            "name": "PT Example Company"
          }
        },
        "photo": {
          "url": "https://example.com/photos/john_doe.jpg"
        },
        "manager": {
          "id": "0100902f-5d8f-4de4-8fae-5ced86831dd1",
          "identificationNumber": "MGR5678",
          "name": "Jane Smith",
          "joinDate": "2020-01-14",
          "startDate": "2020-01-14",
          "active": true,
          "pointOfHire": {
            "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
            "code": "JKT-01",
            "name": "Jakarta Head Office",
            "locationGroup": {
              "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
              "code": "HQ",
              "name": "Headquarters"
            },
            "city": {
              "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
              "code": "31.70",
              "name": "Jakarta",
              "state": {
                "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
                "name": "Jakarta Special Capital Region",
                "code": "31",
                "country": {
                  "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
                  "code": "IDN",
                  "callingCode": "62",
                  "name": "Indonesia",
                  "taxTreaty": true
                }
              }
            },
            "latitude": -6.2088,
            "longitude": 106.8456,
            "address": "Jl. Jenderal Sudirman Kav. 52-53",
            "phone": "[phone]",
            "zipCode": "12190",
            "headquarter": true,
            "company": {
              "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
              "code": "COMP-A",
              "name": "PT Example Company"
            }
          },
          "photo": {
            "url": "https://example.com/photos/jane_smith.jpg"
          }
        }
      }
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "effectiveDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Contact Information

get

Return the contact information.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

Responses

200

OK

application/json

idstringOptional

mobilePhonestringOptional

emailstringOptional

deprecated

workEmailstringOptional

personalEmailstringOptional

originalAddressstringOptional

originalAddressPhoneNumberstringOptional

facebookstringOptional

linkedInstringOptional

effectiveDatestring · dateOptional

YYYY-MM-DD

createdBystringOptional

createdDatenumberOptional

updatedBystringOptional

updatedDatenumberOptional

400

Bad Request

get

/core/v1/employees/{employeeId}/contact-information

cURLPython SDK

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

{
  "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0ab",
  "mobilePhone": "+1231",
  "email": "[e-mail]",
  "workEmail": "[e-mail]",
  "personalEmail": "[e-mail]",
  "originalAddress": "10 Bayfront Ave",
  "originalAddressPhoneNumber": "+2231",
  "originalAddressDetail": {
    "address": "10 Bayfront Ave",
    "zipCode": "54321",
    "phone": "+2231",
    "district": "San Andreas",
    "city": {
      "id": "2d1e9f5a-a6ea-11e6-80f5-76304dec7eb7",
      "code": "NYC",
      "name": "New York City",
      "state": {
        "id": "71f59dbe-a699-11e6-80f5-76304dec7eb7",
        "code": "NY",
        "name": "New York",
        "country": {
          "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
          "code": "US",
          "name": "United States"
        }
      }
    }
  },
  "facebook": "",
  "linkedIn": "",
  "effectiveDate": "2023-01-15",
  "createdBy": "system",
  "createdDate": 1481024187133,
  "updatedBy": "system",
  "updatedDate": 1481024187133,
  "residentialAddress": {
    "address": "123 Main Street",
    "zipCode": "12345",
    "phone": "[phone]",
    "district": "San Andreas",
    "city": {
      "id": "city-123",
      "code": "NYC",
      "name": "New York City",
      "state": {
        "id": "state-123",
        "code": "NY",
        "name": "New York",
        "country": {
          "id": "country-123",
          "code": "US",
          "name": "United States"
        }
      }
    }
  },
  "emergencyContact": {
    "name": "Emergency Contact",
    "relation": "Friend",
    "phone": "[phone]"
  },
  "employee": {
    "id": "e18f5618-bc6c-11e6-80f5-76304dec7eb1",
    "identificationNumber": "EMP12345",
    "name": "John Doe",
    "joinDate": "2022-08-15",
    "startDate": "2022-08-15",
    "active": true,
    "pointOfHire": {
      "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
      "code": "JKT-01",
      "name": "Jakarta Head Office",
      "locationGroup": {
        "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
        "code": "HQ",
        "name": "Headquarters"
      },
      "city": {
        "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
        "code": "31.70",
        "name": "Jakarta",
        "state": {
          "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
          "name": "Jakarta Special Capital Region",
          "code": "31",
          "country": {
            "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
            "code": "IDN",
            "callingCode": "62",
            "name": "Indonesia",
            "taxTreaty": true
          }
        }
      },
      "latitude": -6.2088,
      "longitude": 106.8456,
      "address": "Jl. Jenderal Sudirman Kav. 52-53",
      "phone": "[phone]",
      "zipCode": "12190",
      "headquarter": true,
      "company": {
        "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
        "code": "COMP-A",
        "name": "PT Example Company"
      }
    },
    "photo": {
      "url": "https://example.com/photos/john_doe.jpg"
    },
    "manager": {
      "id": "0100902f-5d8f-4de4-8fae-5ced86831dd1",
      "identificationNumber": "MGR5678",
      "name": "Jane Smith",
      "joinDate": "2020-01-14",
      "startDate": "2020-01-14",
      "active": true,
      "pointOfHire": {
        "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
        "code": "JKT-01",
        "name": "Jakarta Head Office",
        "locationGroup": {
          "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
          "code": "HQ",
          "name": "Headquarters"
        },
        "city": {
          "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
          "code": "31.70",
          "name": "Jakarta",
          "state": {
            "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
            "name": "Jakarta Special Capital Region",
            "code": "31",
            "country": {
              "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
              "code": "IDN",
              "callingCode": "62",
              "name": "Indonesia",
              "taxTreaty": true
            }
          }
        },
        "latitude": -6.2088,
        "longitude": 106.8456,
        "address": "Jl. Jenderal Sudirman Kav. 52-53",
        "phone": "[phone]",
        "zipCode": "12190",
        "headquarter": true,
        "company": {
          "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
          "code": "COMP-A",
          "name": "PT Example Company"
        }
      },
      "photo": {
        "url": "https://example.com/photos/jane_smith.jpg"
      }
    }
  }
}

Update Contact Information

put

Update the contact information.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

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

Body

application/json

emailstringOptional

mobilePhonestringOptional

e.g. [phone]

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

originalAddressstringOptional

Responses

200

OK

application/json

idstringOptional

mobilePhonestringOptional

emailstringOptional

deprecated

workEmailstringOptional

personalEmailstringOptional

originalAddressstringOptional

originalAddressPhoneNumberstringOptional

facebookstringOptional

linkedInstringOptional

effectiveDatestring · dateOptional

YYYY-MM-DD

createdBystringOptional

createdDatenumberOptional

updatedBystringOptional

updatedDatenumberOptional

400

Bad Request

put

/core/v1/employees/{employeeId}/contact-information

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/contact-information" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "[e-mail]",
  "mobilePhone": "[phone]",
  "originalAddress": ""
}'

{
  "id": "47f02912-b9ab-4b64-a044-5cad5c5a73d0",
  "originalAddress": "",
  "originalAddressPhoneNumber": "",
  "mobilePhone": "[phone]",
  "email": "[e-mail]",
  "workEmail": "[e-mail]",
  "personalEmail": "[e-mail]",
  "facebook": "",
  "linkedIn": "",
  "effectiveDate": "2023-01-15",
  "createdBy": "system",
  "createdDate": 1481024187133,
  "updatedBy": "system",
  "updatedDate": 1481024187133,
  "residentialAddress": {
    "address": "123 Main Street",
    "zipCode": "12345",
    "phone": "[phone]",
    "district": "San Andreas",
    "city": {
      "id": "city-123",
      "code": "NYC",
      "name": "New York City",
      "state": {
        "id": "state-123",
        "code": "NY",
        "name": "New York",
        "country": {
          "id": "country-123",
          "code": "US",
          "name": "United States"
        }
      }
    }
  },
  "emergencyContact": {
    "name": "Emergency Contact",
    "relation": "Friend",
    "phone": "[phone]"
  },
  "employee": {
    "id": "e18f5618-bc6c-11e6-80f5-76304dec7eb1",
    "identificationNumber": "EMP12345",
    "name": "John Doe",
    "joinDate": "2022-08-15",
    "startDate": "2022-08-15",
    "active": true,
    "pointOfHire": {
      "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
      "code": "JKT-01",
      "name": "Jakarta Head Office",
      "locationGroup": {
        "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
        "code": "HQ",
        "name": "Headquarters"
      },
      "city": {
        "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
        "code": "31.70",
        "name": "Jakarta",
        "state": {
          "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
          "name": "Jakarta Special Capital Region",
          "code": "31",
          "country": {
            "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
            "code": "IDN",
            "callingCode": "62",
            "name": "Indonesia",
            "taxTreaty": true
          }
        }
      },
      "latitude": -6.2088,
      "longitude": 106.8456,
      "address": "Jl. Jenderal Sudirman Kav. 52-53",
      "phone": "[phone]",
      "zipCode": "12190",
      "headquarter": true,
      "company": {
        "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
        "code": "COMP-A",
        "name": "PT Example Company"
      }
    },
    "photo": {
      "url": "https://example.com/photos/john_doe.jpg"
    },
    "manager": {
      "id": "0100902f-5d8f-4de4-8fae-5ced86831dd1",
      "identificationNumber": "MGR5678",
      "name": "Jane Smith",
      "joinDate": "2020-01-14",
      "startDate": "2020-01-14",
      "active": true,
      "pointOfHire": {
        "id": "f5a7c2b0-9db1-47d0-b93e-960ea2d7b0ac",
        "code": "JKT-01",
        "name": "Jakarta Head Office",
        "locationGroup": {
          "id": "g8h9i0j-9db1-47d0-b93e-960ea2d7b0ad",
          "code": "HQ",
          "name": "Headquarters"
        },
        "city": {
          "id": "h79d4a0f-9db1-47d0-b93e-960ea2d7b0af",
          "code": "31.70",
          "name": "Jakarta",
          "state": {
            "id": "d79d4a0f-9db1-47d0-b93e-960ea2d7b0aj",
            "name": "Jakarta Special Capital Region",
            "code": "31",
            "country": {
              "id": "c79d4a0f-9db1-47d0-b93e-960ea2d7b0al",
              "code": "IDN",
              "callingCode": "62",
              "name": "Indonesia",
              "taxTreaty": true
            }
          }
        },
        "latitude": -6.2088,
        "longitude": 106.8456,
        "address": "Jl. Jenderal Sudirman Kav. 52-53",
        "phone": "[phone]",
        "zipCode": "12190",
        "headquarter": true,
        "company": {
          "id": "k1l2m3n-9db1-47d0-b93e-960ea2d7b0ae",
          "code": "COMP-A",
          "name": "PT Example Company"
        }
      },
      "photo": {
        "url": "https://example.com/photos/jane_smith.jpg"
      }
    }
  }
}